LuaScriptAPI.dox 265 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271
  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. - void SetVariant(const Variant& value)
  2673. - void SetVariantMap(const VariantMap& value)
  2674. - JSONValueType GetValueType() const
  2675. - JSONNumberType GetNumberType() const
  2676. - String GetValueTypeName() const
  2677. - String GetNumberTypeName() const
  2678. - bool IsNull() const
  2679. - bool IsBool() const
  2680. - bool IsNumber() const
  2681. - bool IsString() const
  2682. - bool IsArray() const
  2683. - bool IsObject() const
  2684. - bool GetBool() const
  2685. - int GetInt() const
  2686. - unsigned GetUInt() const
  2687. - float GetFloat() const
  2688. - double GetDouble() const
  2689. - const String GetString() const
  2690. - const JSONArray& GetArray() const
  2691. - const JSONObject& GetObject() const
  2692. - Variant GetVariant() const
  2693. - VariantMap GetVariantMap() const
  2694. - JSONValue operator&[](unsigned index, JSONValue tolua_value)
  2695. - JSONValue operator[](unsigned index)
  2696. - const JSONValue operator[](unsigned index) const
  2697. - void Push(const JSONValue& value)
  2698. - void Pop()
  2699. - void Insert(unsigned pos, const JSONValue& value)
  2700. - void Erase(unsigned pos, unsigned length = 1)
  2701. - void Resize(unsigned newSize)
  2702. - unsigned Size() const
  2703. - void Set(const String key, const JSONValue& value)
  2704. - const JSONValue& Get(const String key) const
  2705. - bool Erase(const String key)
  2706. - bool Contains(const String key) const
  2707. - void Clear()
  2708. Properties:
  2709. - const JSONValue EMPTY
  2710. - const JSONArray emptyArray
  2711. - const JSONObject emptyObject
  2712. - bool null (readonly)
  2713. - JSONValueType valueType (readonly)
  2714. - JSONNumberType numberType (readonly)
  2715. - String valueTypeName (readonly)
  2716. - String numberTypeName (readonly)
  2717. <a name="Class_JoystickState"></a>
  2718. ### JoystickState
  2719. Methods:
  2720. - bool IsController() const
  2721. - unsigned GetNumButtons() const
  2722. - unsigned GetNumAxes() const
  2723. - unsigned GetNumHats() const
  2724. - bool GetButtonDown(unsigned index) const
  2725. - bool GetButtonPress(unsigned index) const
  2726. - float GetAxisPosition(unsigned index) const
  2727. - int GetHatPosition(unsigned index) const
  2728. Properties:
  2729. - const String name
  2730. - const int joystickID
  2731. - bool controller (readonly)
  2732. - unsigned numButtons (readonly)
  2733. - unsigned numAxes (readonly)
  2734. - unsigned numHats (readonly)
  2735. <a name="Class_Light"></a>
  2736. ### Light : Drawable
  2737. Methods:
  2738. - void SetLightType(LightType type)
  2739. - void SetPerVertex(bool enable)
  2740. - void SetColor(const Color& color)
  2741. - void SetTemperature(float temperature)
  2742. - void SetRadius(float redius)
  2743. - void SetLength(float length)
  2744. - void SetUsePhysicalValues(bool enable)
  2745. - void SetSpecularIntensity(float intensity)
  2746. - void SetBrightness(float brightness)
  2747. - void SetRange(float range)
  2748. - void SetFov(float fov)
  2749. - void SetAspectRatio(float aspectRatio)
  2750. - void SetFadeDistance(float distance)
  2751. - void SetShadowFadeDistance(float distance)
  2752. - void SetShadowBias(const BiasParameters& parameters)
  2753. - void SetShadowCascade(const CascadeParameters& parameters)
  2754. - void SetShadowFocus(const FocusParameters& parameters)
  2755. - void SetShadowIntensity(float intensity)
  2756. - void SetShadowResolution(float resolution)
  2757. - void SetShadowNearFarRatio(float nearFarRatio)
  2758. - void SetShadowMaxExtrusion(float extrusion)
  2759. - void SetRampTexture(Texture* texture)
  2760. - void SetShapeTexture(Texture* texture)
  2761. - LightType GetLightType() const
  2762. - bool GetPerVertex() const
  2763. - const Color& GetColor() const
  2764. - float GetTemperature() const
  2765. - float GetRadius() const
  2766. - float GetLength() const
  2767. - float GetSpecularIntensity() const
  2768. - float GetBrightness() const
  2769. - Color GetEffectiveColor() const
  2770. - Color GetColorFromTemperature() const
  2771. - bool GetUsePhysicalValues() const
  2772. - float GetEffectiveSpecularIntensity() const
  2773. - float GetRange() const
  2774. - float GetFov() const
  2775. - float GetAspectRatio() const
  2776. - float GetFadeDistance() const
  2777. - float GetShadowFadeDistance() const
  2778. - const BiasParameters& GetShadowBias() const
  2779. - const CascadeParameters& GetShadowCascade() const
  2780. - const FocusParameters& GetShadowFocus() const
  2781. - float GetShadowIntensity() const
  2782. - float GetShadowResolution() const
  2783. - float GetShadowNearFarRatio() const
  2784. - float GetShadowMaxExtrusion() const
  2785. - Texture* GetRampTexture() const
  2786. - Texture* GetShapeTexture() const
  2787. - Frustum GetFrustum() const
  2788. - int GetNumShadowSplits() const
  2789. - bool IsNegative() const
  2790. Properties:
  2791. - LightType lightType
  2792. - bool perVertex
  2793. - Color& color
  2794. - float temperature
  2795. - float radius
  2796. - float length
  2797. - bool usePhysicalValues
  2798. - float specularIntensity
  2799. - float brightness
  2800. - float range
  2801. - float fov
  2802. - float aspectRatio
  2803. - float fadeDistance
  2804. - float shadowFadeDistance
  2805. - BiasParameters& shadowBias
  2806. - CascadeParameters& shadowCascade
  2807. - FocusParameters& shadowFocus
  2808. - float shadowIntensity
  2809. - float shadowResolution
  2810. - float shadowNearFarRatio
  2811. - float shadowMaxExtrusion
  2812. - Texture* rampTexture
  2813. - Texture* shapeTexture
  2814. - Frustum frustum (readonly)
  2815. - int numShadowSplits (readonly)
  2816. - bool negative (readonly)
  2817. - Color effectiveColor (readonly)
  2818. - float effectiveSpecularIntensity (readonly)
  2819. <a name="Class_LineEdit"></a>
  2820. ### LineEdit : BorderImage
  2821. Methods:
  2822. - LineEdit() (GC)
  2823. - LineEdit* new()
  2824. - void delete()
  2825. - void SetText(const String text)
  2826. - void SetCursorPosition(unsigned position)
  2827. - void SetCursorBlinkRate(float rate)
  2828. - void SetMaxLength(unsigned length)
  2829. - void SetEchoCharacter(unsigned c)
  2830. - void SetCursorMovable(bool enable)
  2831. - void SetTextSelectable(bool enable)
  2832. - void SetTextCopyable(bool enable)
  2833. - const String GetText() const
  2834. - unsigned GetCursorPosition() const
  2835. - float GetCursorBlinkRate() const
  2836. - unsigned GetMaxLength() const
  2837. - unsigned GetEchoCharacter() const
  2838. - bool IsCursorMovable() const
  2839. - bool IsTextSelectable() const
  2840. - bool IsTextCopyable() const
  2841. - Text* GetTextElement() const
  2842. - BorderImage* GetCursor() const
  2843. Properties:
  2844. - String text
  2845. - unsigned cursorPosition
  2846. - float cursorBlinkRate
  2847. - unsigned maxLength
  2848. - unsigned echoCharacter
  2849. - bool cursorMovable
  2850. - bool textSelectable
  2851. - bool textCopyable
  2852. - Text* textElement (readonly)
  2853. - BorderImage* cursor (readonly)
  2854. <a name="Class_ListView"></a>
  2855. ### ListView : ScrollView
  2856. Methods:
  2857. - ListView() (GC)
  2858. - ListView* new()
  2859. - void delete()
  2860. - void AddItem(UIElement* item)
  2861. - void InsertItem(unsigned index, UIElement* item, UIElement* parentItem = 0)
  2862. - void RemoveItem(UIElement* item, unsigned index = 0)
  2863. - void RemoveItem(unsigned index)
  2864. - void RemoveAllItems()
  2865. - void SetSelection(unsigned index)
  2866. - void SetSelections(const PODVector<unsigned>& indices)
  2867. - void AddSelection(unsigned index)
  2868. - void RemoveSelection(unsigned index)
  2869. - void ToggleSelection(unsigned index)
  2870. - void ChangeSelection(int delta, bool additive = false)
  2871. - void ClearSelection()
  2872. - void SetHighlightMode(HighlightMode mode)
  2873. - void SetMultiselect(bool enable)
  2874. - void SetHierarchyMode(bool enable)
  2875. - void SetBaseIndent(int baseIndent)
  2876. - void SetClearSelectionOnDefocus(bool enable)
  2877. - void SetSelectOnClickEnd(bool enable)
  2878. - void Expand(unsigned index, bool enable, bool recursive = false)
  2879. - void ToggleExpand(unsigned index, bool recursive = false)
  2880. - unsigned GetNumItems() const
  2881. - UIElement* GetItem(unsigned index) const
  2882. - const PODVector<UIElement*>& GetItems() const
  2883. - unsigned FindItem(UIElement* item) const
  2884. - unsigned GetSelection() const
  2885. - const PODVector<unsigned>& GetSelections() const
  2886. - void CopySelectedItemsToClipboard() const
  2887. - UIElement* GetSelectedItem() const
  2888. - const PODVector<UIElement*>& GetSelectedItems() const
  2889. - bool IsSelected(unsigned index) const
  2890. - bool IsExpanded(unsigned index) const
  2891. - HighlightMode GetHighlightMode() const
  2892. - bool GetMultiselect() const
  2893. - bool GetClearSelectionOnDefocus() const
  2894. - bool GetSelectOnClickEnd() const
  2895. - bool GetHierarchyMode() const
  2896. - int GetBaseIndent() const
  2897. Properties:
  2898. - unsigned numItems (readonly)
  2899. - unsigned selection
  2900. - UIElement* selectedItem (readonly)
  2901. - HighlightMode highlightMode
  2902. - bool multiselect
  2903. - bool clearSelectionOnDefocus
  2904. - bool selectOnClickEnd
  2905. - bool hierarchyMode
  2906. - int baseIndent
  2907. <a name="Class_Localization"></a>
  2908. ### Localization : Object
  2909. Methods:
  2910. - int GetNumLanguages() const
  2911. - int GetLanguageIndex() const
  2912. - int GetLanguageIndex(const String language)
  2913. - String GetLanguage()
  2914. - String GetLanguage(int index)
  2915. - void SetLanguage(const String language)
  2916. - void SetLanguage(int index)
  2917. - String Get(const String id)
  2918. - void Reset()
  2919. - void LoadJSON(const JSONValue& source)
  2920. - void LoadJSONFile(const String name)
  2921. Properties:
  2922. - int numLanguages (readonly)
  2923. - int languageIndex (readonly)
  2924. - String language (readonly)
  2925. <a name="Class_Log"></a>
  2926. ### Log : Object
  2927. Methods:
  2928. - void Open(const String fileName)
  2929. - void Close()
  2930. - void SetLevel(int level)
  2931. - void SetTimeStamp(bool enable)
  2932. - void SetQuiet(bool quiet)
  2933. - int GetLevel() const
  2934. - bool GetTimeStamp() const
  2935. - String GetLastMessage() const
  2936. - bool IsQuiet() const
  2937. - void Write(int level, const String message)
  2938. - void WriteRaw(const String message, bool error = false)
  2939. Properties:
  2940. - int level
  2941. - bool timeStamp
  2942. - bool quiet
  2943. <a name="Class_LuaScriptInstance"></a>
  2944. ### LuaScriptInstance : Component
  2945. Methods:
  2946. - bool CreateObject(const String scriptObjectType)
  2947. - bool CreateObject(LuaFile* scriptFile, const String scriptObjectType)
  2948. - void SetScriptFile(LuaFile* scriptFile)
  2949. - void SetScriptObjectType(const String scriptObjectType)
  2950. - void SubscribeToEvent(const String eventName, void* functionOrFunctionName)
  2951. - void SubscribeToEvent(void* sender, const String eventName, void* functionOrFunctionName)
  2952. - void UnsubscribeFromEvent(const String eventName)
  2953. - void UnsubscribeFromEvent(Object* sender, const String eventName)
  2954. - void UnsubscribeFromEvents(Object* sender)
  2955. - void UnsubscribeFromAllEvents()
  2956. - void UnsubscribeFromAllEventsExcept(const Vector<String>& exceptionNames)
  2957. - bool HasSubscribedToEvent(const String eventName)
  2958. - bool HasSubscribedToEvent(Object* sender, const String eventName)
  2959. - LuaFile* GetScriptFile() const
  2960. - const String GetScriptObjectType() const
  2961. Properties:
  2962. - const LuaFile* scriptFile
  2963. - const String scriptObjectType
  2964. <a name="Class_Material"></a>
  2965. ### Material : Resource
  2966. Methods:
  2967. - Material() (GC)
  2968. - Material* new()
  2969. - void delete()
  2970. - void SetNumTechniques(unsigned num)
  2971. - void SetTechnique(unsigned index, Technique* tech, unsigned qualityLevel = 0, float lodDistance = 0.0f)
  2972. - void SetVertexShaderDefines(const String defines)
  2973. - void SetPixelShaderDefines(const String defines)
  2974. - void SetShaderParameter(const String name, const Variant& value)
  2975. - void SetShaderParameterAnimation(const String name, ValueAnimation* animation, WrapMode wrapMode = WM_LOOP, float speed = 1.0f)
  2976. - void SetShaderParameterAnimationWrapMode(const String name, WrapMode wrapMode)
  2977. - void SetShaderParameterAnimationSpeed(const String name, float speed)
  2978. - void SetTexture(TextureUnit unit, Texture* texture)
  2979. - void SetUVTransform(const Vector2& offset, float rotation, const Vector2& repeat)
  2980. - void SetUVTransform(const Vector2& offset, float rotation, float repeat)
  2981. - void SetCullMode(CullMode mode)
  2982. - void SetShadowCullMode(CullMode mode)
  2983. - void SetFillMode(FillMode mode)
  2984. - void SetDepthBias(const BiasParameters& parameters)
  2985. - void SetAlphaToCoverage(bool enable)
  2986. - void SetLineAntiAlias(bool enable)
  2987. - void SetRenderOrder(char renderOrder)
  2988. - void SetOcclusion(bool enable)
  2989. - void SetScene(Scene* scene)
  2990. - void RemoveShaderParameter(const String name)
  2991. - void ReleaseShaders()
  2992. - Material* Clone(const String cloneName = String::EMPTY) const
  2993. - void SortTechniques()
  2994. - void MarkForAuxView(unsigned frameNumber)
  2995. - unsigned GetNumTechniques() const
  2996. - Technique* GetTechnique(unsigned index) const
  2997. - Pass* GetPass(unsigned index, const String passName) const
  2998. - Texture* GetTexture(TextureUnit unit) const
  2999. - const String GetVertexShaderDefines() const
  3000. - const String GetPixelShaderDefines() const
  3001. - ValueAnimation* GetShaderParameterAnimation(const String name) const
  3002. - WrapMode GetShaderParameterAnimationWrapMode(const String name) const
  3003. - float GetShaderParameterAnimationSpeed(const String name) const
  3004. - CullMode GetCullMode() const
  3005. - CullMode GetShadowCullMode() const
  3006. - FillMode GetFillMode() const
  3007. - const BiasParameters& GetDepthBias() const
  3008. - bool GetAlphaToCoverage() const
  3009. - bool GetLineAntiAlias() const
  3010. - char GetRenderOrder() const
  3011. - bool GetOcclusion() const
  3012. - bool GetSpecular() const
  3013. - Scene* GetScene() const
  3014. Properties:
  3015. - String vertexShaderDefines
  3016. - String pixelShaderDefines
  3017. - CullMode cullMode
  3018. - CullMode shadowCullMode
  3019. - FillMode fillMode
  3020. - BiasParameters depthBias
  3021. - bool alphaToCoverage
  3022. - bool lineAntiAlias
  3023. - char renderOrder
  3024. - bool occlusion
  3025. - bool specular (readonly)
  3026. - Scene* scene
  3027. <a name="Class_Matrix3"></a>
  3028. ### Matrix3
  3029. Methods:
  3030. - Matrix3() (GC)
  3031. - Matrix3* new()
  3032. - Matrix3(const Matrix3& matrix) (GC)
  3033. - Matrix3* new(const Matrix3& matrix)
  3034. - Matrix3(float v00, float v01, float v02, float v10, float v11, float v12, float v20, float v21, float v22) (GC)
  3035. - Matrix3* new(float v00, float v01, float v02, float v10, float v11, float v12, float v20, float v21, float v22)
  3036. - void delete()
  3037. - bool operator==(const Matrix3& rhs) const
  3038. - Vector3 operator*(const Vector3& rhs) const
  3039. - Matrix3 operator+(const Matrix3& rhs) const
  3040. - Matrix3 operator-(const Matrix3& rhs) const
  3041. - Matrix3 operator*(float rhs) const
  3042. - Matrix3 operator*(const Matrix3& rhs) const
  3043. - void SetScale(const Vector3& scale)
  3044. - void SetScale(float scale)
  3045. - Vector3 Scale() const
  3046. - Matrix3 Transpose() const
  3047. - Matrix3 Scaled(const Vector3& scale) const
  3048. - bool Equals(const Matrix3& rhs) const
  3049. - Matrix3 Inverse() const
  3050. - String ToString() const
  3051. Properties:
  3052. - float m00
  3053. - float m01
  3054. - float m02
  3055. - float m10
  3056. - float m11
  3057. - float m12
  3058. - float m20
  3059. - float m21
  3060. - float m22
  3061. - const Matrix3 ZERO
  3062. - const Matrix3 IDENTITY
  3063. <a name="Class_Matrix3x4"></a>
  3064. ### Matrix3x4
  3065. Methods:
  3066. - Matrix3x4() (GC)
  3067. - Matrix3x4* new()
  3068. - Matrix3x4(const Matrix3x4& matrix) (GC)
  3069. - Matrix3x4* new(const Matrix3x4& matrix)
  3070. - Matrix3x4(const Matrix3& matrix) (GC)
  3071. - Matrix3x4* new(const Matrix3& matrix)
  3072. - Matrix3x4(const Matrix4& matrix) (GC)
  3073. - Matrix3x4* new(const Matrix4& matrix)
  3074. - 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)
  3075. - 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)
  3076. - Matrix3x4(const Vector3& translation, const Quaternion& rotation, float scale) (GC)
  3077. - Matrix3x4* new(const Vector3& translation, const Quaternion& rotation, float scale)
  3078. - Matrix3x4(const Vector3& translation, const Quaternion& rotation, const Vector3& scale) (GC)
  3079. - Matrix3x4* new(const Vector3& translation, const Quaternion& rotation, const Vector3& scale)
  3080. - void delete()
  3081. - bool operator==(const Matrix3x4& rhs) const
  3082. - Vector3 operator*(const Vector3& rhs) const
  3083. - Vector3 operator*(const Vector4& rhs) const
  3084. - Matrix3x4 operator+(const Matrix3x4& rhs) const
  3085. - Matrix3x4 operator-(const Matrix3x4& rhs) const
  3086. - Matrix3x4 operator*(float rhs) const
  3087. - Matrix3x4 operator*(const Matrix3x4& rhs) const
  3088. - Matrix4 operator*(const Matrix4& rhs) const
  3089. - void SetTranslation(const Vector3& translation)
  3090. - void SetRotation(const Matrix3& rotation)
  3091. - void SetScale(const Vector3& scale)
  3092. - void SetScale(float scale)
  3093. - Matrix3 ToMatrix3() const
  3094. - Matrix4 ToMatrix4() const
  3095. - Matrix3 RotationMatrix() const
  3096. - Vector3 Translation() const
  3097. - Quaternion Rotation() const
  3098. - Vector3 Scale() const
  3099. - bool Equals(const Matrix3x4& rhs) const
  3100. - void Decompose(Vector3& translation, Quaternion& rotation, Vector3& scale) const
  3101. - Matrix3x4 Inverse() const
  3102. - String ToString() const
  3103. Properties:
  3104. - float m00
  3105. - float m01
  3106. - float m02
  3107. - float m03
  3108. - float m10
  3109. - float m11
  3110. - float m12
  3111. - float m13
  3112. - float m20
  3113. - float m21
  3114. - float m22
  3115. - float m23
  3116. - const Matrix3x4 ZERO
  3117. - const Matrix3x4 IDENTITY
  3118. <a name="Class_Matrix4"></a>
  3119. ### Matrix4
  3120. Methods:
  3121. - Matrix4() (GC)
  3122. - Matrix4* new()
  3123. - Matrix4(const Matrix4& matrix) (GC)
  3124. - Matrix4* new(const Matrix4& matrix)
  3125. - Matrix4(const Matrix3& matrix) (GC)
  3126. - Matrix4* new(const Matrix3& matrix)
  3127. - 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)
  3128. - 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)
  3129. - void delete()
  3130. - bool operator==(const Matrix4& rhs) const
  3131. - Vector3 operator*(const Vector3& rhs) const
  3132. - Vector4 operator*(const Vector4& rhs) const
  3133. - Matrix4 operator+(const Matrix4& rhs) const
  3134. - Matrix4 operator-(const Matrix4& rhs) const
  3135. - Matrix4 operator*(float rhs) const
  3136. - Matrix4 operator*(const Matrix4& rhs) const
  3137. - Matrix4 operator*(const Matrix3x4& rhs) const
  3138. - void SetTranslation(const Vector3& translation)
  3139. - void SetRotation(const Matrix3& rotation)
  3140. - void SetScale(const Vector3& scale)
  3141. - void SetScale(float scale)
  3142. - Matrix3 ToMatrix3() const
  3143. - Matrix3 RotationMatrix() const
  3144. - Vector3 Translation() const
  3145. - Quaternion Rotation() const
  3146. - Vector3 Scale() const
  3147. - Matrix4 Transpose() const
  3148. - bool Equals(const Matrix4& rhs) const
  3149. - void Decompose(Vector3& translation, Quaternion& rotation, Vector3& scale) const
  3150. - Matrix4 Inverse() const
  3151. - String ToString() const
  3152. Properties:
  3153. - float m00
  3154. - float m01
  3155. - float m02
  3156. - float m03
  3157. - float m10
  3158. - float m11
  3159. - float m12
  3160. - float m13
  3161. - float m20
  3162. - float m21
  3163. - float m22
  3164. - float m23
  3165. - float m30
  3166. - float m31
  3167. - float m32
  3168. - float m33
  3169. - const Matrix4 ZERO
  3170. - const Matrix4 IDENTITY
  3171. <a name="Class_Menu"></a>
  3172. ### Menu : Button
  3173. Methods:
  3174. - Menu() (GC)
  3175. - Menu* new()
  3176. - void delete()
  3177. - void SetPopup(UIElement* element)
  3178. - void SetPopupOffset(const IntVector2& offset)
  3179. - void SetPopupOffset(int x, int y)
  3180. - void ShowPopup(bool enable)
  3181. - void SetAccelerator(int key, int qualifiers)
  3182. - UIElement* GetPopup() const
  3183. - const IntVector2& GetPopupOffset() const
  3184. - bool GetShowPopup() const
  3185. - int GetAcceleratorKey() const
  3186. - int GetAcceleratorQualifiers() const
  3187. Properties:
  3188. - UIElement* popup
  3189. - IntVector2& popupOffset
  3190. - bool showPopup
  3191. - int acceleratorKey (readonly)
  3192. - int acceleratorQualifiers (readonly)
  3193. <a name="Class_MessageBox"></a>
  3194. ### MessageBox : Object
  3195. Methods:
  3196. - MessageBox(const String messageString = String::EMPTY, const String titleString = String::EMPTY, XMLFile* layoutFile = 0, XMLFile* styleFile = 0) (GC)
  3197. - MessageBox* new(const String messageString = String::EMPTY, const String titleString = String::EMPTY, XMLFile* layoutFile = 0, XMLFile* styleFile = 0)
  3198. - void delete()
  3199. - void SetTitle(const String text)
  3200. - void SetMessage(const String text)
  3201. - const String GetTitle() const
  3202. - const String GetMessage() const
  3203. - UIElement* GetWindow() const
  3204. Properties:
  3205. - String title
  3206. - String message
  3207. - UIElement* window (readonly)
  3208. <a name="Class_Model"></a>
  3209. ### Model : Resource
  3210. Methods:
  3211. - Model() (GC)
  3212. - Model* new()
  3213. - void delete()
  3214. - Model* Clone(const String cloneName = String::EMPTY) const
  3215. - void SetBoundingBox(const BoundingBox& box)
  3216. - bool SetVertexBuffers(const Vector<SharedPtr<VertexBuffer> >& buffers, const PODVector<unsigned>& morphRangeStarts, const PODVector<unsigned>& morphRangeCounts)
  3217. - bool SetIndexBuffers(const Vector<SharedPtr<IndexBuffer> >& buffers)
  3218. - void SetNumGeometries(unsigned num)
  3219. - bool SetNumGeometryLodLevels(unsigned index, unsigned num)
  3220. - bool SetGeometry(unsigned index, unsigned lodLevel, Geometry* geometry)
  3221. - bool SetGeometryCenter(unsigned index, const Vector3& center)
  3222. - const BoundingBox& GetBoundingBox() const
  3223. - Skeleton& GetSkeleton()
  3224. - unsigned GetNumGeometries() const
  3225. - unsigned GetNumGeometryLodLevels(unsigned index) const
  3226. - Geometry* GetGeometry(unsigned index, unsigned lodLevel) const
  3227. - const Vector3& GetGeometryCenter(unsigned index) const
  3228. - unsigned GetNumMorphs() const
  3229. - const ModelMorph* GetMorph(const String name) const
  3230. - const ModelMorph* GetMorph(StringHash nameHash) const
  3231. - const ModelMorph* GetMorph(unsigned index) const
  3232. - unsigned GetMorphRangeStart(unsigned bufferIndex) const
  3233. - unsigned GetMorphRangeCount(unsigned bufferIndex) const
  3234. Properties:
  3235. - BoundingBox& boundingBox
  3236. - Skeleton skeleton (readonly)
  3237. - unsigned numGeometries
  3238. - unsigned numMorphs (readonly)
  3239. <a name="Class_NamedPipe"></a>
  3240. ### NamedPipe : Object
  3241. Methods:
  3242. - NamedPipe() (GC)
  3243. - NamedPipe* new()
  3244. - NamedPipe(const String pipeName, bool isServer) (GC)
  3245. - NamedPipe* new(const String pipeName, bool isServer)
  3246. - void delete()
  3247. - bool Open(const String pipeName, bool isServer)
  3248. - void Close()
  3249. - bool IsOpen() const
  3250. - VectorBuffer Read(unsigned size)
  3251. - const String GetName() const
  3252. - bool IsEof() const
  3253. - int ReadInt()
  3254. - short ReadShort()
  3255. - char ReadByte()
  3256. - unsigned ReadUInt()
  3257. - short ReadUShort()
  3258. - char ReadUByte()
  3259. - bool ReadBool()
  3260. - float ReadFloat()
  3261. - double ReadDouble()
  3262. - IntRect ReadIntRect()
  3263. - IntVector2 ReadIntVector2()
  3264. - IntVector3 ReadIntVector3()
  3265. - Rect ReadRect()
  3266. - Vector2 ReadVector2()
  3267. - Vector3 ReadVector3()
  3268. - Vector3 ReadPackedVector3(float maxAbsCoord)
  3269. - Vector4 ReadVector4()
  3270. - Quaternion ReadQuaternion()
  3271. - Quaternion ReadPackedQuaternion()
  3272. - Matrix3 ReadMatrix3()
  3273. - Matrix3x4 ReadMatrix3x4()
  3274. - Matrix4 ReadMatrix4()
  3275. - Color ReadColor()
  3276. - BoundingBox ReadBoundingBox()
  3277. - String ReadString()
  3278. - String ReadFileID()
  3279. - StringHash ReadStringHash()
  3280. - VectorBuffer ReadBuffer()
  3281. - ResourceRef ReadResourceRef()
  3282. - ResourceRefList ReadResourceRefList()
  3283. - Variant ReadVariant()
  3284. - Variant ReadVariant(VariantType type)
  3285. - VariantVector ReadVariantVector()
  3286. - VariantMap ReadVariantMap()
  3287. - unsigned ReadVLE()
  3288. - unsigned ReadNetID()
  3289. - String ReadLine()
  3290. - unsigned Write(const VectorBuffer& buffer)
  3291. - bool WriteInt(int value)
  3292. - bool WriteShort(short value)
  3293. - bool WriteByte(char value)
  3294. - bool WriteUInt(unsigned value)
  3295. - bool WriteUShort(short value)
  3296. - bool WriteUByte(char value)
  3297. - bool WriteBool(bool value)
  3298. - bool WriteFloat(float value)
  3299. - bool WriteDouble(double value)
  3300. - bool WriteIntRect(const IntRect& value)
  3301. - bool WriteIntVector2(const IntVector2& value)
  3302. - bool WriteIntVector3(const IntVector3& value)
  3303. - bool WriteRect(const Rect& value)
  3304. - bool WriteVector2(const Vector2& value)
  3305. - bool WriteVector3(const Vector3& value)
  3306. - bool WritePackedVector3(const Vector3& value, float maxAbsCoord)
  3307. - bool WriteVector4(const Vector4& value)
  3308. - bool WriteQuaternion(const Quaternion& value)
  3309. - bool WritePackedQuaternion(const Quaternion& value)
  3310. - bool WriteMatrix3(const Matrix3& value)
  3311. - bool WriteMatrix3x4(const Matrix3x4& value)
  3312. - bool WriteMatrix4(const Matrix4& value)
  3313. - bool WriteColor(const Color& value)
  3314. - bool WriteBoundingBox(const BoundingBox& value)
  3315. - bool WriteString(const String value)
  3316. - bool WriteFileID(const String value)
  3317. - bool WriteStringHash(const StringHash& value)
  3318. - bool WriteBuffer(const VectorBuffer& buffer)
  3319. - bool WriteResourceRef(const ResourceRef& value)
  3320. - bool WriteResourceRefList(const ResourceRefList& value)
  3321. - bool WriteVariant(const Variant& value)
  3322. - bool WriteVariantData(const Variant& value)
  3323. - bool WriteVariantVector(const VariantVector& value)
  3324. - bool WriteVariantMap(const VariantMap& value)
  3325. - bool WriteVLE(unsigned value)
  3326. - bool WriteNetID(unsigned value)
  3327. - bool WriteLine(const String value)
  3328. Properties:
  3329. - String name (readonly)
  3330. - bool eof (readonly)
  3331. - bool open (readonly)
  3332. <a name="Class_NavArea"></a>
  3333. ### NavArea : Component
  3334. Methods:
  3335. - unsigned GetAreaID() const
  3336. - void SetAreaID(unsigned tolua_var_3)
  3337. - BoundingBox GetBoundingBox()
  3338. - void SetBoundingBox(const BoundingBox& bnds)
  3339. - BoundingBox GetWorldBoundingBox() const
  3340. Properties:
  3341. - unsigned areaID
  3342. - BoundingBox boundingBox
  3343. - BoundingBox worldBoundingBox (readonly)
  3344. <a name="Class_Navigable"></a>
  3345. ### Navigable : Component
  3346. Methods:
  3347. - void SetRecursive(bool enable)
  3348. - bool IsRecursive() const
  3349. Properties:
  3350. - bool recursive
  3351. <a name="Class_NavigationGeometryInfo"></a>
  3352. ### NavigationGeometryInfo
  3353. Properties:
  3354. - Component* component
  3355. - unsigned lodLevel
  3356. - Matrix3x4 transform
  3357. - BoundingBox boundingBox
  3358. <a name="Class_NavigationMesh"></a>
  3359. ### NavigationMesh : Component
  3360. Methods:
  3361. - void SetTileSize(int size)
  3362. - void SetCellSize(float size)
  3363. - void SetCellHeight(float height)
  3364. - void SetAgentHeight(float height)
  3365. - void SetAgentRadius(float radius)
  3366. - void SetAgentMaxClimb(float maxClimb)
  3367. - void SetAgentMaxSlope(float maxSlope)
  3368. - void SetRegionMinSize(float size)
  3369. - void SetRegionMergeSize(float size)
  3370. - void SetEdgeMaxLength(float length)
  3371. - void SetEdgeMaxError(float error)
  3372. - void SetDetailSampleDistance(float distance)
  3373. - void SetDetailSampleMaxError(float error)
  3374. - void SetPadding(const Vector3& padding)
  3375. - void SetAreaCost(unsigned areaID, float cost)
  3376. - bool Build()
  3377. - bool Build(const BoundingBox& boundingBox)
  3378. - void SetPartitionType(NavmeshPartitionType aType)
  3379. - void SetDrawOffMeshConnections(bool enable)
  3380. - void SetDrawNavAreas(bool enable)
  3381. - Vector3 FindNearestPoint(const Vector3& point)
  3382. - Vector3 FindNearestPoint(const Vector3& point, const Vector3& extents)
  3383. - Vector3 MoveAlongSurface(const Vector3& start, const Vector3& end)
  3384. - Vector3 MoveAlongSurface(const Vector3& start, const Vector3& end, const Vector3& extents, int maxVisited = 3)
  3385. - const PODVector<Vector3>& FindPath(const Vector3& start, const Vector3& end)
  3386. - const PODVector<Vector3>& FindPath(const Vector3& start, const Vector3& end, const Vector3& extents)
  3387. - Vector3 GetRandomPoint()
  3388. - Vector3 GetRandomPointInCircle(const Vector3& center, float radius)
  3389. - Vector3 GetRandomPointInCircle(const Vector3& center, float radius, const Vector3& extents)
  3390. - float GetDistanceToWall(const Vector3& point, float radius)
  3391. - float GetDistanceToWall(const Vector3& point, float radius, const Vector3& extents)
  3392. - Vector3 Raycast(const Vector3& start, const Vector3& end)
  3393. - Vector3 Raycast(const Vector3& start, const Vector3& end, const Vector3& extents)
  3394. - void DrawDebugGeometry(bool depthTest)
  3395. - int GetTileSize() const
  3396. - float GetCellSize() const
  3397. - float GetCellHeight() const
  3398. - float GetAgentHeight() const
  3399. - float GetAgentRadius() const
  3400. - float GetAgentMaxClimb() const
  3401. - float GetAgentMaxSlope() const
  3402. - float GetRegionMinSize() const
  3403. - float GetRegionMergeSize() const
  3404. - float GetEdgeMaxLength() const
  3405. - float GetEdgeMaxError() const
  3406. - float GetDetailSampleDistance() const
  3407. - float GetDetailSampleMaxError() const
  3408. - const Vector3& GetPadding() const
  3409. - float GetAreaCost(unsigned areaID) const
  3410. - bool IsInitialized() const
  3411. - const BoundingBox& GetBoundingBox() const
  3412. - BoundingBox GetWorldBoundingBox() const
  3413. - IntVector2 GetNumTiles() const
  3414. - NavmeshPartitionType GetPartitionType()
  3415. - bool GetDrawOffMeshConnections() const
  3416. - bool GetDrawNavAreas() const
  3417. Properties:
  3418. - int tileSize
  3419. - float cellSize
  3420. - float cellHeight
  3421. - float agentHeight
  3422. - float agentRadius
  3423. - float agentMaxClimb
  3424. - float agentMaxSlope
  3425. - float regionMinSize
  3426. - float regionMergeSize
  3427. - float edgeMaxLength
  3428. - float edgeMaxError
  3429. - float detailSampleDistance
  3430. - float detailSampleMaxError
  3431. - Vector3& padding
  3432. - NavmeshPartitionType partitionType
  3433. - bool drawOffMeshConnections
  3434. - bool drawNavAreas
  3435. - bool initialized (readonly)
  3436. - BoundingBox& boundingBox (readonly)
  3437. - BoundingBox worldBoundingBox (readonly)
  3438. - IntVector2 numTiles (readonly)
  3439. <a name="Class_Network"></a>
  3440. ### Network
  3441. Methods:
  3442. - bool Connect(const String address, short port, Scene* scene)
  3443. - bool Connect(const String address, short port, Scene* scene, const VariantMap& identity)
  3444. - void Disconnect(int waitMSec = 0)
  3445. - bool StartServer(short port)
  3446. - void StopServer()
  3447. - void BroadcastMessage(int msgID, bool reliable, bool inOrder, const VectorBuffer& msg, unsigned contentID = 0)
  3448. - void BroadcastRemoteEvent(StringHash eventType, bool inOrder)
  3449. - void BroadcastRemoteEvent(StringHash eventType, bool inOrder, const VariantMap& eventData)
  3450. - void BroadcastRemoteEvent(const String eventType, bool inOrder)
  3451. - void BroadcastRemoteEvent(const String eventType, bool inOrder, const VariantMap& eventData)
  3452. - void BroadcastRemoteEvent(Scene* scene, StringHash eventType, bool inOrder)
  3453. - void BroadcastRemoteEvent(Scene* scene, StringHash eventType, bool inOrder, const VariantMap& eventData)
  3454. - void BroadcastRemoteEvent(Scene* scene, const String eventType, bool inOrder)
  3455. - void BroadcastRemoteEvent(Scene* scene, const String eventType, bool inOrder, const VariantMap& eventData)
  3456. - void BroadcastRemoteEvent(Node* node, StringHash eventType, bool inOrder)
  3457. - void BroadcastRemoteEvent(Node* node, StringHash eventType, bool inOrder, const VariantMap& eventData)
  3458. - void BroadcastRemoteEvent(Node* node, const String eventType, bool inOrder)
  3459. - void BroadcastRemoteEvent(Node* node, const String eventType, bool inOrder, const VariantMap& eventData)
  3460. - void SetUpdateFps(int fps)
  3461. - void SetSimulatedLatency(int ms)
  3462. - void SetSimulatedPacketLoss(float loss)
  3463. - void RegisterRemoteEvent(StringHash eventType)
  3464. - void RegisterRemoteEvent(const String eventType)
  3465. - void UnregisterRemoteEvent(StringHash eventType)
  3466. - void UnregisterRemoteEvent(const String eventType)
  3467. - void UnregisterAllRemoteEvents()
  3468. - void SetPackageCacheDir(const String path)
  3469. - void SendPackageToClients(Scene* scene, PackageFile* package)
  3470. - HttpRequest* MakeHttpRequest(const String url, const String verb = String::EMPTY)
  3471. - HttpRequest* MakeHttpRequest(const String url, const String verb, const Vector<String>& headers, const String postData = String::EMPTY)
  3472. - int GetUpdateFps() const
  3473. - int GetSimulatedLatency() const
  3474. - float GetSimulatedPacketLoss() const
  3475. - Connection* GetServerConnection() const
  3476. - bool IsServerRunning() const
  3477. - bool CheckRemoteEvent(StringHash eventType) const
  3478. - const String GetPackageCacheDir() const
  3479. Properties:
  3480. - int updateFps
  3481. - int simulatedLatency
  3482. - float simulatedPacketLoss
  3483. - Connection* serverConnection (readonly)
  3484. - bool serverRunning (readonly)
  3485. - String packageCacheDir
  3486. <a name="Class_NetworkPriority"></a>
  3487. ### NetworkPriority : Component
  3488. Methods:
  3489. - void SetBasePriority(float priority)
  3490. - void SetDistanceFactor(float factor)
  3491. - void SetMinPriority(float priority)
  3492. - void SetAlwaysUpdateOwner(bool enable)
  3493. - float GetBasePriority() const
  3494. - float GetDistanceFactor() const
  3495. - float GetMinPriority() const
  3496. - bool GetAlwaysUpdateOwner() const
  3497. - bool CheckUpdate(float distance, float accumulator)
  3498. Properties:
  3499. - float basePriority
  3500. - float distanceFactor
  3501. - float minPriority
  3502. - bool alwaysUpdateOwner
  3503. <a name="Class_Node"></a>
  3504. ### Node : Animatable
  3505. Methods:
  3506. - Node() (GC)
  3507. - Node* new()
  3508. - void delete()
  3509. - bool SaveXML(File* dest, const String indentation = "\t") const
  3510. - bool SaveJSON(File* dest, const String indentation = "\t") const
  3511. - void SetName(const String name)
  3512. - void AddTag(const String tag)
  3513. - void AddTags(const String tags, char separator)
  3514. - bool RemoveTag(const String tag)
  3515. - void RemoveAllTags()
  3516. - void SetPosition(const Vector3& position)
  3517. - void SetPosition2D(const Vector2& position)
  3518. - void SetPosition2D(float x, float y)
  3519. - void SetRotation(const Quaternion& rotation)
  3520. - void SetRotation2D(float rotation)
  3521. - void SetDirection(const Vector3& direction)
  3522. - void SetScale(float scale)
  3523. - void SetScale(const Vector3& scale)
  3524. - void SetScale2D(const Vector2& scale)
  3525. - void SetScale2D(float x, float y)
  3526. - void SetTransform(const Vector3& position, const Quaternion& rotation)
  3527. - void SetTransform(const Vector3& position, const Quaternion& rotation, const Vector3& scale)
  3528. - void SetTransform(const Vector3& position, const Quaternion& rotation, float scale)
  3529. - void SetTransform(const Matrix3x4& transform)
  3530. - void SetTransform2D(const Vector2& position, float rotation)
  3531. - void SetTransform2D(const Vector2& position, float rotation, const Vector2& scale)
  3532. - void SetTransform2D(const Vector2& position, float rotation, float scale)
  3533. - void SetWorldPosition(const Vector3& position)
  3534. - void SetWorldPosition2D(const Vector2& position)
  3535. - void SetWorldPosition2D(float x, float y)
  3536. - void SetWorldRotation(const Quaternion& rotation)
  3537. - void SetWorldRotation2D(float rotation)
  3538. - void SetWorldDirection(const Vector3& direction)
  3539. - void SetWorldScale(float scale)
  3540. - void SetWorldScale(const Vector3& scale)
  3541. - void SetWorldScale2D(const Vector2& scale)
  3542. - void SetWorldScale2D(float x, float y)
  3543. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation)
  3544. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation, const Vector3& scale)
  3545. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation, float scale)
  3546. - void SetWorldTransform2D(const Vector2& position, float rotation)
  3547. - void SetWorldTransform2D(const Vector2& position, float rotation, const Vector2& scale)
  3548. - void SetWorldTransform2D(const Vector2& position, float rotation, float scale)
  3549. - void Translate(const Vector3& delta, TransformSpace space = TS_LOCAL)
  3550. - void Translate2D(const Vector2& delta, TransformSpace space = TS_LOCAL)
  3551. - void Rotate(const Quaternion& delta, TransformSpace space = TS_LOCAL)
  3552. - void Rotate2D(float delta, TransformSpace space = TS_LOCAL)
  3553. - void RotateAround(const Vector3& point, const Quaternion& delta, TransformSpace space = TS_LOCAL)
  3554. - void RotateAround2D(const Vector2& point, float delta, TransformSpace space = TS_LOCAL)
  3555. - void Pitch(float angle, TransformSpace space = TS_LOCAL)
  3556. - void Yaw(float angle, TransformSpace space = TS_LOCAL)
  3557. - void Roll(float angle, TransformSpace space = TS_LOCAL)
  3558. - bool LookAt(const Vector3& target)
  3559. - bool LookAt(const Vector3& target, const Vector3& upAxis, TransformSpace space = TS_WORLD)
  3560. - void Scale(float scale)
  3561. - void Scale(const Vector3& scale)
  3562. - void Scale2D(const Vector2& scale)
  3563. - void SetEnabled(bool enable)
  3564. - void SetDeepEnabled(bool enable)
  3565. - void ResetDeepEnabled()
  3566. - void SetEnabledRecursive(bool enable)
  3567. - void SetOwner(Connection* owner)
  3568. - void MarkDirty()
  3569. - Node* CreateChild(const String name = String::EMPTY, CreateMode mode = REPLICATED, unsigned id = 0, bool temporary = false)
  3570. - Node* CreateTemporaryChild(const String name = String::EMPTY, CreateMode mode = REPLICATED, unsigned id = 0)
  3571. - void AddChild(Node* node, unsigned index = M_MAX_UNSIGNED)
  3572. - void RemoveChild(Node* node)
  3573. - void RemoveAllChildren()
  3574. - void RemoveChildren(bool removeReplicated, bool removeLocal, bool recursive)
  3575. - void RemoveComponent(Component* component)
  3576. - void RemoveComponent(StringHash type)
  3577. - void RemoveComponent(const String type)
  3578. - void RemoveComponents(bool removeReplicated, bool removeLocal)
  3579. - void RemoveComponents(const String type)
  3580. - void RemoveAllComponents()
  3581. - void ReorderComponent(Component* component, unsigned index)
  3582. - Node* Clone(CreateMode mode = REPLICATED)
  3583. - void Remove()
  3584. - void SetParent(Node* parent)
  3585. - void SetVar(StringHash key, const Variant& value)
  3586. - void AddListener(Component* component)
  3587. - void RemoveListener(Component* component)
  3588. - Component* CreateComponent(const String type, CreateMode mode = REPLICATED, unsigned id = 0)
  3589. - Component* GetOrCreateComponent(const String type, CreateMode mode = REPLICATED, unsigned id = 0)
  3590. - Component* CloneComponent(Component* component, unsigned id = 0)
  3591. - Component* CloneComponent(Component* component, CreateMode mode, unsigned id = 0)
  3592. - int CreateScriptObject(const String scriptObjectType)
  3593. - int CreateScriptObject(const String fileName, const String scriptObjectType)
  3594. - int GetScriptObject() const
  3595. - int GetScriptObject(const String scriptObjectType) const
  3596. - unsigned GetID() const
  3597. - const String GetName() const
  3598. - StringHash GetNameHash() const
  3599. - Node* GetParent() const
  3600. - Scene* GetScene() const
  3601. - bool IsChildOf(Node* node) const
  3602. - bool IsEnabled() const
  3603. - bool IsEnabledSelf() const
  3604. - Connection* GetOwner() const
  3605. - const Vector3& GetPosition() const
  3606. - Vector2 GetPosition2D() const
  3607. - const Quaternion& GetRotation() const
  3608. - float GetRotation2D() const
  3609. - Vector3 GetDirection() const
  3610. - Vector3 GetUp() const
  3611. - Vector3 GetRight() const
  3612. - const Vector3& GetScale() const
  3613. - Vector2 GetScale2D() const
  3614. - Matrix3x4 GetTransform() const
  3615. - Vector3 GetWorldPosition() const
  3616. - Vector2 GetWorldPosition2D() const
  3617. - Quaternion GetWorldRotation() const
  3618. - float GetWorldRotation2D() const
  3619. - Vector3 GetWorldDirection() const
  3620. - Vector3 GetWorldUp() const
  3621. - Vector3 GetWorldRight() const
  3622. - Vector3 GetWorldScale() const
  3623. - Vector3 GetSignedWorldScale() const
  3624. - Vector2 GetWorldScale2D() const
  3625. - const Matrix3x4& GetWorldTransform() const
  3626. - Vector3 LocalToWorld(const Vector3& position) const
  3627. - Vector3 LocalToWorld(const Vector4& vector) const
  3628. - Vector2 LocalToWorld2D(const Vector2& vector) const
  3629. - Vector3 WorldToLocal(const Vector3& position) const
  3630. - Vector3 WorldToLocal(const Vector4& vector) const
  3631. - Vector2 WorldToLocal2D(const Vector2& vector) const
  3632. - bool IsDirty() const
  3633. - unsigned GetNumChildren(bool recursive = false) const
  3634. - Node* GetChild(const String name, bool recursive = false) const
  3635. - Node* GetChild(StringHash nameHash, bool recursive = false) const
  3636. - Node* GetChild(unsigned index) const
  3637. - unsigned GetNumComponents() const
  3638. - unsigned GetNumNetworkComponents() const
  3639. - bool HasComponent(StringHash type) const
  3640. - bool HasComponent(const String type) const
  3641. - const Variant& GetVar(StringHash key) const
  3642. - const VariantMap& GetVars() const
  3643. - Component* GetComponent(const String type, bool recursive = false) const
  3644. - Component* GetParentComponent(const String type, bool recursive = false) const
  3645. - const PODVector<Component*>& GetComponents(const String type, bool recursive = false)
  3646. - const PODVector<Node*>& GetChildren(bool recursive = false)
  3647. - const PODVector<Node*>& GetChildrenWithComponent(const String type, bool recursive = false)
  3648. - bool Load(Deserializer& source, SceneResolver& resolver, bool loadChildren = true, bool rewriteIDs = false, CreateMode mode = REPLICATED)
  3649. - bool LoadXML(const XMLElement& source, SceneResolver& resolver, bool loadChildren = true, bool rewriteIDs = false, CreateMode mode = REPLICATED)
  3650. - bool LoadJSON(const JSONValue& source, SceneResolver& resolver, bool loadChildren = true, bool rewriteIDs = false, CreateMode mode = REPLICATED)
  3651. - Node* CreateChild(unsigned id, CreateMode mode, bool temporary = false)
  3652. - void AddComponent(Component* component, unsigned id, CreateMode mode)
  3653. - bool HasTag(const String tag) const
  3654. - const StringVector& GetTags() const
  3655. - const PODVector<Node*>& GetChildrenWithTag(const String tag, bool recursive = false) const
  3656. - void SetID(unsigned id)
  3657. Properties:
  3658. - unsigned ID (readonly)
  3659. - String name
  3660. - StringHash nameHash (readonly)
  3661. - Node* parent
  3662. - Scene* scene (readonly)
  3663. - bool enabled
  3664. - bool enabledSelf (readonly)
  3665. - Connection* owner
  3666. - Vector3& position
  3667. - Vector2 position2D
  3668. - Quaternion& rotation
  3669. - float rotation2D
  3670. - Vector3 direction
  3671. - Vector3 up (readonly)
  3672. - Vector3 right (readonly)
  3673. - Vector3& scale
  3674. - Vector2 scale2D
  3675. - Matrix3x4 transform (readonly)
  3676. - Vector3 worldPosition
  3677. - Vector2 worldPosition2D
  3678. - Quaternion worldRotation
  3679. - float worldRotation2D
  3680. - Vector3 worldDirection
  3681. - Vector3 worldUp (readonly)
  3682. - Vector3 worldRight (readonly)
  3683. - Vector3 worldScale
  3684. - Vector3 signedWorldScale (readonly)
  3685. - Vector2 worldScale2D
  3686. - Matrix3x4& worldTransform (readonly)
  3687. - bool dirty (readonly)
  3688. - unsigned numComponents (readonly)
  3689. - unsigned numNetworkComponents (readonly)
  3690. <a name="Class_Object"></a>
  3691. ### Object : RefCounted
  3692. Methods:
  3693. - StringHash GetType() const
  3694. - const String GetTypeName() const
  3695. - const String GetCategory() const
  3696. - void SendEvent(const String eventName, VariantMap* eventData = 0)
  3697. - bool HasSubscribedToEvent(const String eventName) const
  3698. - bool HasSubscribedToEvent(Object* sender, const String eventName) const
  3699. Properties:
  3700. - StringHash type (readonly)
  3701. - const String typeName (readonly)
  3702. - const String category (readonly)
  3703. <a name="Class_ObjectAnimation"></a>
  3704. ### ObjectAnimation : Resource
  3705. Methods:
  3706. - ObjectAnimation() (GC)
  3707. - ObjectAnimation* new()
  3708. - void delete()
  3709. - void AddAttributeAnimation(const String name, ValueAnimation* attributeAnimation, WrapMode wrapMode = WM_LOOP, float speed = 1.0f)
  3710. - void RemoveAttributeAnimation(const String name)
  3711. - void RemoveAttributeAnimation(ValueAnimation* attributeAnimation)
  3712. - ValueAnimation* GetAttributeAnimation(const String name) const
  3713. - WrapMode GetAttributeAnimationWrapMode(const String name) const
  3714. - float GetAttributeAnimationSpeed(const String name) const
  3715. <a name="Class_Obstacle"></a>
  3716. ### Obstacle : Component
  3717. Methods:
  3718. - void DrawDebugGeometry(bool depthTest)
  3719. - void SetRadius(float radius)
  3720. - void SetHeight(float height)
  3721. - float GetRadius() const
  3722. - float GetHeight() const
  3723. Properties:
  3724. - float radius
  3725. - float height
  3726. <a name="Class_Octree"></a>
  3727. ### Octree : Component
  3728. Methods:
  3729. - void SetSize(const BoundingBox& box, unsigned numLevels)
  3730. - void Update(const FrameInfo& frame)
  3731. - void AddManualDrawable(Drawable* drawable)
  3732. - void RemoveManualDrawable(Drawable* drawable)
  3733. - const PODVector<OctreeQueryResult>& GetDrawables(const Vector3& point, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3734. - const PODVector<OctreeQueryResult>& GetDrawables(const BoundingBox& box, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3735. - const PODVector<OctreeQueryResult>& GetDrawables(const Frustum& frustum, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3736. - const PODVector<OctreeQueryResult>& GetDrawables(const Sphere& sphere, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3737. - const PODVector<OctreeQueryResult>& GetAllDrawables(char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3738. - const PODVector<RayQueryResult>& Raycast(const Ray& ray, RayQueryLevel level, float maxDistance, char drawableFlags, unsigned viewMask = DEFAULT_VIEWMASK) const
  3739. - RayQueryResult RaycastSingle(const Ray& ray, RayQueryLevel level, float maxDistance, char drawableFlags, unsigned viewMask = DEFAULT_VIEWMASK) const
  3740. - unsigned GetNumLevels() const
  3741. - void QueueUpdate(Drawable* drawable)
  3742. - void DrawDebugGeometry(bool depthTest)
  3743. Properties:
  3744. - unsigned numLevels (readonly)
  3745. <a name="Class_OctreeQueryResult"></a>
  3746. ### OctreeQueryResult
  3747. Methods:
  3748. - OctreeQueryResult() (GC)
  3749. - OctreeQueryResult* new()
  3750. - void delete()
  3751. Properties:
  3752. - Drawable* drawable
  3753. - Node* node
  3754. <a name="Class_OffMeshConnection"></a>
  3755. ### OffMeshConnection : Component
  3756. Methods:
  3757. - void SetEndPoint(Node* node)
  3758. - void SetRadius(float radius)
  3759. - void SetBidirectional(bool enabled)
  3760. - void SetMask(unsigned newMask)
  3761. - void SetAreaID(unsigned newAreaID)
  3762. - Node* GetEndPoint() const
  3763. - float GetRadius() const
  3764. - bool IsBidirectional() const
  3765. - unsigned GetMask() const
  3766. - unsigned GetAreaID() const
  3767. Properties:
  3768. - Node* endPoint
  3769. - float radius
  3770. - bool bidirectional
  3771. - unsigned mask
  3772. - unsigned areaID
  3773. <a name="Class_PackageEntry"></a>
  3774. ### PackageEntry
  3775. Properties:
  3776. - unsigned offset
  3777. - unsigned size
  3778. - unsigned checksum
  3779. <a name="Class_PackageFile"></a>
  3780. ### PackageFile : Object
  3781. Methods:
  3782. - PackageFile() (GC)
  3783. - PackageFile* new()
  3784. - PackageFile(const String fileName, unsigned startOffset = 0) (GC)
  3785. - PackageFile* new(const String fileName, unsigned startOffset = 0)
  3786. - void delete()
  3787. - bool Open(const String fileName, unsigned startOffset = 0)
  3788. - bool Exists(const String fileName) const
  3789. - const PackageEntry* GetEntry(const String fileName) const
  3790. - const HashMap<String,PackageEntry>& GetEntries() const
  3791. - const String GetName() const
  3792. - StringHash GetNameHash() const
  3793. - unsigned GetNumFiles() const
  3794. - unsigned GetTotalSize() const
  3795. - unsigned GetTotalDataSize() const
  3796. - unsigned GetChecksum() const
  3797. - bool IsCompressed() const
  3798. Properties:
  3799. - String name (readonly)
  3800. - StringHash nameHash (readonly)
  3801. - unsigned numFiles (readonly)
  3802. - unsigned totalSize (readonly)
  3803. - unsigned totalDataSize (readonly)
  3804. - unsigned checksum (readonly)
  3805. - bool compressed (readonly)
  3806. <a name="Class_ParticleEffect"></a>
  3807. ### ParticleEffect : Resource
  3808. Methods:
  3809. - ParticleEffect() (GC)
  3810. - ParticleEffect* new()
  3811. - void delete()
  3812. - void SetMaterial(Material* material)
  3813. - void SetNumParticles(unsigned num)
  3814. - void SetUpdateInvisible(bool enable)
  3815. - void SetRelative(bool enable)
  3816. - void SetScaled(bool enable)
  3817. - void SetSorted(bool enable)
  3818. - void SetFixedScreenSize(bool enable)
  3819. - void SetAnimationLodBias(float lodBias)
  3820. - void SetEmitterType(EmitterType type)
  3821. - void SetEmitterSize(const Vector3& size)
  3822. - void SetMinDirection(const Vector3& direction)
  3823. - void SetMaxDirection(const Vector3& direction)
  3824. - void SetConstantForce(const Vector3& force)
  3825. - void SetDampingForce(float force)
  3826. - void SetActiveTime(float time)
  3827. - void SetInactiveTime(float time)
  3828. - void SetMinEmissionRate(float rate)
  3829. - void SetMaxEmissionRate(float rate)
  3830. - void SetMinParticleSize(const Vector2& size)
  3831. - void SetMaxParticleSize(const Vector2& size)
  3832. - void SetMinTimeToLive(float time)
  3833. - void SetMaxTimeToLive(float time)
  3834. - void SetMinVelocity(float velocity)
  3835. - void SetMaxVelocity(float velocity)
  3836. - void SetMinRotation(float rotation)
  3837. - void SetMaxRotation(float rotation)
  3838. - void SetMinRotationSpeed(float speed)
  3839. - void SetMaxRotationSpeed(float speed)
  3840. - void SetSizeAdd(float sizeAdd)
  3841. - void SetSizeMul(float sizeMul)
  3842. - void AddColorTime(const Color& color, const float time)
  3843. - void AddColorFrame(const ColorFrame& colorFrame)
  3844. - void RemoveColorFrame(unsigned index)
  3845. - void SetColorFrame(unsigned index, const ColorFrame& colorFrame)
  3846. - void SetNumColorFrames(unsigned number)
  3847. - void SortColorFrames()
  3848. - void AddTextureTime(const Rect& uv, const float time)
  3849. - void AddTextureFrame(const TextureFrame& textureFrame)
  3850. - void RemoveTextureFrame(unsigned index)
  3851. - void SetTextureFrame(unsigned index, const TextureFrame& textureFrame)
  3852. - void SetNumTextureFrames(unsigned number)
  3853. - void SortTextureFrames()
  3854. - ParticleEffect* Clone(const String cloneName = String::EMPTY) const
  3855. - Material* GetMaterial() const
  3856. - unsigned GetNumParticles() const
  3857. - bool GetUpdateInvisible() const
  3858. - bool IsRelative() const
  3859. - bool IsScaled() const
  3860. - bool IsSorted() const
  3861. - bool IsFixedScreenSize() const
  3862. - float GetAnimationLodBias() const
  3863. - EmitterType GetEmitterType() const
  3864. - const Vector3& GetEmitterSize() const
  3865. - const Vector3& GetMinDirection() const
  3866. - const Vector3& GetMaxDirection() const
  3867. - const Vector3& GetConstantForce() const
  3868. - float GetDampingForce() const
  3869. - float GetActiveTime() const
  3870. - float GetInactiveTime() const
  3871. - float GetMinEmissionRate() const
  3872. - float GetMaxEmissionRate() const
  3873. - const Vector2& GetMinParticleSize() const
  3874. - const Vector2& GetMaxParticleSize() const
  3875. - float GetMinTimeToLive() const
  3876. - float GetMaxTimeToLive() const
  3877. - float GetMinVelocity() const
  3878. - float GetMaxVelocity() const
  3879. - float GetMinRotation() const
  3880. - float GetMaxRotation() const
  3881. - float GetMinRotationSpeed() const
  3882. - float GetMaxRotationSpeed() const
  3883. - float GetSizeAdd() const
  3884. - float GetSizeMul() const
  3885. - unsigned GetNumColorFrames() const
  3886. - const ColorFrame* GetColorFrame(unsigned index) const
  3887. - unsigned GetNumTextureFrames() const
  3888. - const TextureFrame* GetTextureFrame(unsigned index) const
  3889. Properties:
  3890. - Material* material
  3891. - unsigned numParticles
  3892. - bool updateInvisible
  3893. - bool relative
  3894. - bool scaled
  3895. - bool sorted
  3896. - bool fixedScreenSize
  3897. - float animationLodBias
  3898. - EmitterType emitterType
  3899. - const Vector3& emitterSize
  3900. - const Vector3& minDirection
  3901. - const Vector3& maxDirection
  3902. - const Vector3& constantForce
  3903. - float dampingForce
  3904. - float activeTime
  3905. - float inactiveTime
  3906. - float minEmissionRate
  3907. - float maxEmissionRate
  3908. - const Vector2& minParticleSize
  3909. - const Vector2& maxParticleSize
  3910. - float minTimeToLive
  3911. - float maxTimeToLive
  3912. - float minVelocity
  3913. - float maxVelocity
  3914. - float minRotation
  3915. - float maxRotation
  3916. - float minRotationSpeed
  3917. - float maxRotationSpeed
  3918. - float sizeAdd
  3919. - float sizeMul
  3920. - unsigned numColorFrames
  3921. - unsigned numTextureFrames
  3922. <a name="Class_ParticleEffect2D"></a>
  3923. ### ParticleEffect2D : Resource
  3924. Methods:
  3925. - ParticleEffect2D* Clone(const String cloneName = String::EMPTY) const
  3926. <a name="Class_ParticleEmitter"></a>
  3927. ### ParticleEmitter : BillboardSet
  3928. Methods:
  3929. - void SetEffect(ParticleEffect* effect)
  3930. - void SetNumParticles(unsigned num)
  3931. - void SetEmitting(bool enable)
  3932. - void SetSerializeParticles(bool enable)
  3933. - void SetAutoRemoveMode(AutoRemoveMode mode)
  3934. - void ResetEmissionTimer()
  3935. - void RemoveAllParticles()
  3936. - void Reset()
  3937. - void ApplyEffect()
  3938. - ParticleEffect* GetEffect() const
  3939. - unsigned GetNumParticles() const
  3940. - bool IsEmitting() const
  3941. - bool GetSerializeParticles() const
  3942. - AutoRemoveMode GetAutoRemoveMode() const
  3943. Properties:
  3944. - ParticleEffect* effect
  3945. - unsigned numParticles
  3946. - bool emitting
  3947. - bool serializeParticles
  3948. - AutoRemoveMode autoRemoveMode
  3949. <a name="Class_ParticleEmitter2D"></a>
  3950. ### ParticleEmitter2D : Drawable2D
  3951. Methods:
  3952. - void SetEffect(ParticleEffect2D* effect)
  3953. - void SetSprite(Sprite2D* sprite)
  3954. - void SetBlendMode(BlendMode blendMode)
  3955. - ParticleEffect2D* GetEffect() const
  3956. - Sprite2D* GetSprite() const
  3957. - BlendMode GetBlendMode() const
  3958. Properties:
  3959. - ParticleEffect2D* effect
  3960. - Sprite2D* sprite
  3961. - BlendMode blendMode
  3962. <a name="Class_Pass"></a>
  3963. ### Pass : RefCounted
  3964. Methods:
  3965. - void SetBlendMode(BlendMode mode)
  3966. - void SetCullMode(CullMode mode)
  3967. - void SetDepthTestMode(CompareMode mode)
  3968. - void SetLightingMode(PassLightingMode mode)
  3969. - void SetDepthWrite(bool enable)
  3970. - void SetAlphaToCoverage(bool enable)
  3971. - void SetIsDesktop(bool enable)
  3972. - void SetVertexShader(const String name)
  3973. - void SetPixelShader(const String name)
  3974. - void SetVertexShaderDefines(const String defines)
  3975. - void SetPixelShaderDefines(const String defines)
  3976. - void SetVertexShaderDefineExcludes(const String excludes)
  3977. - void SetPixelShaderDefineExcludes(const String excludes)
  3978. - void ReleaseShaders()
  3979. - const String GetName() const
  3980. - unsigned GetIndex() const
  3981. - CullMode GetCullMode() const
  3982. - BlendMode GetBlendMode() const
  3983. - CompareMode GetDepthTestMode() const
  3984. - PassLightingMode GetLightingMode() const
  3985. - bool GetDepthWrite() const
  3986. - bool GetAlphaToCoverage() const
  3987. - bool IsDesktop() const
  3988. - const String GetVertexShader() const
  3989. - const String GetPixelShader() const
  3990. - const String GetVertexShaderDefines() const
  3991. - const String GetPixelShaderDefines() const
  3992. - const String GetVertexShaderDefineExcludes() const
  3993. - const String GetPixelShaderDefineExcludes() const
  3994. Properties:
  3995. - String name (readonly)
  3996. - unsigned index (readonly)
  3997. - BlendMode blendMode
  3998. - CullMode cullMode
  3999. - CompareMode depthTestMode
  4000. - PassLightingMode lightingMode
  4001. - bool depthWrite
  4002. - bool alphaToCoverage
  4003. - bool desktop (readonly)
  4004. - String vertexShader
  4005. - String pixelShader
  4006. - String vertexShaderDefines
  4007. - String pixelShaderDefines
  4008. - String vertexShaderDefineExcludes
  4009. - String pixelShaderDefineExcludes
  4010. <a name="Class_PhysicsRaycastResult"></a>
  4011. ### PhysicsRaycastResult
  4012. Methods:
  4013. - PhysicsRaycastResult() (GC)
  4014. - PhysicsRaycastResult* new()
  4015. - void delete()
  4016. Properties:
  4017. - Vector3 position
  4018. - Vector3 normal
  4019. - float distance
  4020. - float hitFraction
  4021. - RigidBody* body
  4022. <a name="Class_PhysicsRaycastResult2D"></a>
  4023. ### PhysicsRaycastResult2D
  4024. Methods:
  4025. - PhysicsRaycastResult2D() (GC)
  4026. - PhysicsRaycastResult2D* new()
  4027. - void delete()
  4028. Properties:
  4029. - Vector2 position
  4030. - Vector2 normal
  4031. - float distance
  4032. - RigidBody2D* body
  4033. <a name="Class_PhysicsWorld"></a>
  4034. ### PhysicsWorld : Component
  4035. Methods:
  4036. - void Update(float timeStep)
  4037. - void UpdateCollisions()
  4038. - void SetFps(int fps)
  4039. - void SetGravity(const Vector3& gravity)
  4040. - void SetMaxSubSteps(int num)
  4041. - void SetNumIterations(int num)
  4042. - void SetUpdateEnabled(bool enable)
  4043. - void SetInterpolation(bool enable)
  4044. - void SetInternalEdge(bool enable)
  4045. - void SetSplitImpulse(bool enable)
  4046. - void SetMaxNetworkAngularVelocity(float velocity)
  4047. - const PODVector<PhysicsRaycastResult>& Raycast(const Ray& ray, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  4048. - PhysicsRaycastResult RaycastSingle(const Ray& ray, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  4049. - PhysicsRaycastResult RaycastSingleSegmented(const Ray& ray, float maxDistance, float segmentDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  4050. - PhysicsRaycastResult SphereCast(const Ray& ray, float radius, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  4051. - PhysicsRaycastResult ConvexCast(CollisionShape* shape, const Vector3& startPos, const Quaternion& startRot, const Vector3& endPos, const Quaternion& endRot, unsigned collisionMask = M_MAX_UNSIGNED)
  4052. - const PODVector<RigidBody*>& GetRigidBodies(const Sphere& sphere, unsigned collisionMask = M_MAX_UNSIGNED)
  4053. - const PODVector<RigidBody*>& GetRigidBodies(const BoundingBox& box, unsigned collisionMask = M_MAX_UNSIGNED)
  4054. - const PODVector<RigidBody*>& GetRigidBodies(const RigidBody* body)
  4055. - const PODVector<RigidBody*>& GetCollidingBodies(const RigidBody* body)
  4056. - void DrawDebugGeometry(bool depthTest)
  4057. - void RemoveCachedGeometry(Model* model)
  4058. - Vector3 GetGravity() const
  4059. - int GetMaxSubSteps() const
  4060. - int GetNumIterations() const
  4061. - bool IsUpdateEnabled() const
  4062. - bool GetInterpolation() const
  4063. - bool GetInternalEdge() const
  4064. - bool GetSplitImpulse() const
  4065. - int GetFps() const
  4066. - float GetMaxNetworkAngularVelocity() const
  4067. Properties:
  4068. - Vector3 gravity
  4069. - int maxSubSteps
  4070. - int numIterations
  4071. - bool updateEnabled
  4072. - bool interpolation
  4073. - bool internalEdge
  4074. - bool splitImpulse
  4075. - int fps
  4076. - float maxNetworkAngularVelocity
  4077. <a name="Class_PhysicsWorld2D"></a>
  4078. ### PhysicsWorld2D : Component
  4079. Methods:
  4080. - void DrawDebugGeometry()
  4081. - void SetUpdateEnabled(bool enable)
  4082. - void SetDrawShape(bool drawShape)
  4083. - void SetDrawJoint(bool drawJoint)
  4084. - void SetDrawAabb(bool drawAabb)
  4085. - void SetDrawPair(bool drawPair)
  4086. - void SetDrawCenterOfMass(bool drawCenterOfMass)
  4087. - void SetAllowSleeping(bool enable)
  4088. - void SetWarmStarting(bool enable)
  4089. - void SetContinuousPhysics(bool enable)
  4090. - void SetSubStepping(bool enable)
  4091. - void SetGravity(const Vector2& gravity)
  4092. - void SetAutoClearForces(bool enable)
  4093. - void SetVelocityIterations(int velocityIterations)
  4094. - void SetPositionIterations(int positionIterations)
  4095. - const PODVector<PhysicsRaycastResult2D>& Raycast(const Vector2& startPoint, const Vector2& endPoint, unsigned collisionMask = M_MAX_UNSIGNED)
  4096. - PhysicsRaycastResult2D RaycastSingle(const Vector2& startPoint, const Vector2& endPoint, unsigned collisionMask = M_MAX_UNSIGNED)
  4097. - RigidBody2D* GetRigidBody(const Vector2& point, unsigned collisionMask = M_MAX_UNSIGNED)
  4098. - RigidBody2D* GetRigidBody(int screenX, int screenY, unsigned collisionMask = M_MAX_UNSIGNED)
  4099. - const PODVector<RigidBody2D*>& GetRigidBodies(const Rect& aabb, unsigned collisionMask = M_MAX_UNSIGNED)
  4100. - bool IsUpdateEnabled() const
  4101. - bool GetDrawShape() const
  4102. - bool GetDrawJoint() const
  4103. - bool GetDrawAabb() const
  4104. - bool GetDrawPair() const
  4105. - bool GetDrawCenterOfMass() const
  4106. - bool GetAllowSleeping() const
  4107. - bool GetWarmStarting() const
  4108. - bool GetContinuousPhysics() const
  4109. - bool GetSubStepping() const
  4110. - bool GetAutoClearForces() const
  4111. - const Vector2& GetGravity() const
  4112. - int GetVelocityIterations() const
  4113. - int GetPositionIterations() const
  4114. Properties:
  4115. - bool updateEnabled
  4116. - bool drawShape
  4117. - bool drawJoint
  4118. - bool drawAabb
  4119. - bool drawPair
  4120. - bool drawCenterOfMass
  4121. - bool allowSleeping
  4122. - bool warmStarting
  4123. - bool continuousPhysics
  4124. - bool subStepping
  4125. - bool autoClearForces
  4126. - Vector2& gravity
  4127. - int velocityIterations
  4128. - int positionIterations
  4129. <a name="Class_Plane"></a>
  4130. ### Plane
  4131. Methods:
  4132. - Plane() (GC)
  4133. - Plane* new()
  4134. - Plane(const Plane& plane) (GC)
  4135. - Plane* new(const Plane& plane)
  4136. - Plane(const Vector3& v0, const Vector3& v1, const Vector3& v2) (GC)
  4137. - Plane* new(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  4138. - Plane(const Vector3& normal, const Vector3& point) (GC)
  4139. - Plane* new(const Vector3& normal, const Vector3& point)
  4140. - Plane(const Vector4& plane) (GC)
  4141. - Plane* new(const Vector4& plane)
  4142. - void delete()
  4143. - void Define(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  4144. - void Define(const Vector3& normal, const Vector3& point)
  4145. - void Define(const Vector4& plane)
  4146. - void Transform(const Matrix3& transform)
  4147. - void Transform(const Matrix3x4& transform)
  4148. - void Transform(const Matrix4& transform)
  4149. - Vector3 Project(const Vector3& point) const
  4150. - float Distance(const Vector3& point) const
  4151. - Vector3 Reflect(const Vector3& direction) const
  4152. - Matrix3x4 ReflectionMatrix() const
  4153. - Plane Transformed(const Matrix3& transform) const
  4154. - Plane Transformed(const Matrix3x4& transform) const
  4155. - Plane Transformed(const Matrix4& transform) const
  4156. - Vector4 ToVector4() const
  4157. Properties:
  4158. - Vector3 normal
  4159. - Vector3 absNormal
  4160. - float d
  4161. - const Plane UP
  4162. <a name="Class_Polyhedron"></a>
  4163. ### Polyhedron
  4164. Methods:
  4165. - Polyhedron() (GC)
  4166. - Polyhedron* new()
  4167. - Polyhedron(const Polyhedron& polyhedron) (GC)
  4168. - Polyhedron* new(const Polyhedron& polyhedron)
  4169. - Polyhedron(const BoundingBox& box) (GC)
  4170. - Polyhedron* new(const BoundingBox& box)
  4171. - Polyhedron(const Frustum& frustum) (GC)
  4172. - Polyhedron* new(const Frustum& frustum)
  4173. - void delete()
  4174. - void Define(const BoundingBox& box)
  4175. - void Define(const Frustum& frustum)
  4176. - void AddFace(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  4177. - void AddFace(const Vector3& v0, const Vector3& v1, const Vector3& v2, const Vector3& v3)
  4178. - void Clip(const Plane& plane)
  4179. - void Clip(const BoundingBox& box)
  4180. - void Clip(const Frustum& box)
  4181. - void Clear()
  4182. - void Transform(const Matrix3& transform)
  4183. - void Transform(const Matrix3x4& transform)
  4184. - Polyhedron Transformed(const Matrix3& transform) const
  4185. - Polyhedron Transformed(const Matrix3x4& transform) const
  4186. - bool Empty() const
  4187. Properties:
  4188. - bool empty (readonly)
  4189. <a name="Class_ProgressBar"></a>
  4190. ### ProgressBar : BorderImage
  4191. Methods:
  4192. - ProgressBar() (GC)
  4193. - ProgressBar* new()
  4194. - void delete()
  4195. - void SetOrientation(Orientation orientation)
  4196. - void SetRange(float range)
  4197. - void SetValue(float value)
  4198. - void ChangeValue(float delta)
  4199. - void SetLoadingPercentStyle(const String style)
  4200. - void SetShowPercentText(bool showPercentText)
  4201. - Orientation GetOrientation() const
  4202. - float GetRange() const
  4203. - float GetValue() const
  4204. - BorderImage* GetKnob() const
  4205. - const String GetLoadingPercentStyle()
  4206. - bool GetShowPercentText() const
  4207. Properties:
  4208. - Orientation orientation
  4209. - float range
  4210. - float value
  4211. - BorderImage* knob (readonly)
  4212. - String loadingPercentStyle (readonly)
  4213. - bool showPercentText
  4214. <a name="Class_PropertySet2D"></a>
  4215. ### PropertySet2D
  4216. Methods:
  4217. - bool HasProperty(const String name) const
  4218. - const String GetProperty(const String name) const
  4219. <a name="Class_Quaternion"></a>
  4220. ### Quaternion
  4221. Methods:
  4222. - Quaternion() (GC)
  4223. - Quaternion* new()
  4224. - Quaternion(const Quaternion& quat) (GC)
  4225. - Quaternion* new(const Quaternion& quat)
  4226. - Quaternion(float w, float x, float y, float z) (GC)
  4227. - Quaternion* new(float w, float x, float y, float z)
  4228. - Quaternion(float angle, const Vector3& axis) (GC)
  4229. - Quaternion* new(float angle, const Vector3& axis)
  4230. - Quaternion(float angle) (GC)
  4231. - Quaternion* new(float angle)
  4232. - Quaternion(float x, float y, float z) (GC)
  4233. - Quaternion* new(float x, float y, float z)
  4234. - Quaternion(const Vector3& start, const Vector3& end) (GC)
  4235. - Quaternion* new(const Vector3& start, const Vector3& end)
  4236. - Quaternion(const Vector3& xAxis, const Vector3& yAxis, const Vector3& zAxis) (GC)
  4237. - Quaternion* new(const Vector3& xAxis, const Vector3& yAxis, const Vector3& zAxis)
  4238. - Quaternion(const Matrix3& matrix) (GC)
  4239. - Quaternion* new(const Matrix3& matrix)
  4240. - void delete()
  4241. - bool operator==(const Quaternion& rhs) const
  4242. - Quaternion operator*(float rhs) const
  4243. - Quaternion operator-() const
  4244. - bool operator==(const Quaternion& rhs) const
  4245. - Quaternion operator*(float rhs) const
  4246. - Quaternion operator-() const
  4247. - Quaternion operator+(const Quaternion& rhs) const
  4248. - Quaternion operator-(const Quaternion& rhs) const
  4249. - Quaternion operator*(const Quaternion& rhs) const
  4250. - Vector3 operator*(const Vector3& rhs) const
  4251. - void FromAngleAxis(float angle, const Vector3& axis)
  4252. - void FromEulerAngles(float x, float y, float z)
  4253. - void FromRotationTo(const Vector3& start, const Vector3& end)
  4254. - void FromAxes(const Vector3& xAxis, const Vector3& yAxis, const Vector3& zAxis)
  4255. - void FromRotationMatrix(const Matrix3& matrix)
  4256. - bool FromLookRotation(const Vector3& direction, const Vector3& up)
  4257. - void Normalize()
  4258. - Quaternion Normalized() const
  4259. - Quaternion Inverse() const
  4260. - float LengthSquared() const
  4261. - float DotProduct(const Quaternion& rhs) const
  4262. - bool Equals(const Quaternion& rhs) const
  4263. - bool IsNaN() const
  4264. - Quaternion Conjugate() const
  4265. - Vector3 EulerAngles() const
  4266. - float YawAngle() const
  4267. - float PitchAngle() const
  4268. - float RollAngle() const
  4269. - Vector3 Axis() const
  4270. - float Angle() const
  4271. - Matrix3 RotationMatrix() const
  4272. - Quaternion Slerp(const Quaternion& rhs, float t) const
  4273. - Quaternion Nlerp(const Quaternion& rhs, float t, bool shortestPath) const
  4274. - String ToString() const
  4275. Properties:
  4276. - float w
  4277. - float x
  4278. - float y
  4279. - float z
  4280. - const Quaternion IDENTITY
  4281. <a name="Class_Ray"></a>
  4282. ### Ray
  4283. Methods:
  4284. - Ray() (GC)
  4285. - Ray* new()
  4286. - Ray(const Vector3& origin, const Vector3& direction) (GC)
  4287. - Ray* new(const Vector3& origin, const Vector3& direction)
  4288. - Ray(const Ray& ray) (GC)
  4289. - Ray* new(const Ray& ray)
  4290. - void delete()
  4291. - bool operator==(const Ray& rhs) const
  4292. - void Define(const Vector3& origin, const Vector3& direction)
  4293. - Vector3 Project(const Vector3& point) const
  4294. - float Distance(const Vector3& point) const
  4295. - Vector3 ClosestPoint(const Ray& ray) const
  4296. - float HitDistance(const Plane& plane) const
  4297. - float HitDistance(const BoundingBox& box) const
  4298. - float HitDistance(const Frustum& frustum, bool solidInside = true) const
  4299. - float HitDistance(const Sphere& sphere) const
  4300. - float HitDistance(const Vector3& v0, const Vector3& v1, const Vector3& v2) const
  4301. - Ray Transformed(const Matrix3x4& transform) const
  4302. Properties:
  4303. - Vector3 origin
  4304. - Vector3 direction
  4305. <a name="Class_RayQueryResult"></a>
  4306. ### RayQueryResult
  4307. Methods:
  4308. - RayQueryResult() (GC)
  4309. - RayQueryResult* new()
  4310. - void delete()
  4311. Properties:
  4312. - Vector3 position
  4313. - Vector3 normal
  4314. - Vector2 textureUV
  4315. - float distance
  4316. - Drawable* drawable
  4317. - Node* node
  4318. - unsigned subObject
  4319. <a name="Class_RaycastVehicle"></a>
  4320. ### RaycastVehicle : LogicComponent
  4321. Methods:
  4322. - RaycastVehicle(Urho3D::Context* context) (GC)
  4323. - RaycastVehicle* new(Urho3D::Context* context)
  4324. - void delete()
  4325. - void RegisterObject(Context* context)
  4326. - void ApplyAttributes()
  4327. - void AddWheel(Node* wheelNode, Vector3 wheelDirection, Vector3 wheelAxle, float restLength, float wheelRadius, bool frontWheel)
  4328. - void ResetSuspension()
  4329. - void UpdateWheelTransform(int wheel, bool interpolated)
  4330. - void SetSteeringValue(int wheel, float steeringValue)
  4331. - void SetWheelSuspensionStiffness(int wheel, float stiffness)
  4332. - void SetWheelDampingRelaxation(int wheel, float damping)
  4333. - void SetWheelDampingCompression(int wheel, float compression)
  4334. - void SetWheelFrictionSlip(int wheel, float slip)
  4335. - void SetWheelRollInfluence(int wheel, float rollInfluence)
  4336. - void SetEngineForce(int wheel, float force)
  4337. - void SetBrake(int wheel, float force)
  4338. - void SetWheelRadius(int wheel, float wheelRadius)
  4339. - void ResetWheels()
  4340. - void SetWheelRestLength(int wheel, float length)
  4341. - void SetWheelSkidInfo(int wheel, float factor)
  4342. - bool WheelIsGrounded(int wheel) const
  4343. - void SetMaxSuspensionTravel(int wheel, float maxSuspensionTravel)
  4344. - void SetWheelDirection(int wheel, Vector3 direction)
  4345. - void SetWheelAxle(int wheel, Vector3 axle)
  4346. - void SetMaxSideSlipSpeed(float speed)
  4347. - void SetWheelSkidInfoCumulative(int wheel, float skid)
  4348. - void SetInAirRPM(float rpm)
  4349. - void Init()
  4350. - Vector3 GetWheelPosition(int wheel)
  4351. - Quaternion GetWheelRotation(int wheel)
  4352. - Vector3 GetWheelConnectionPoint(int wheel)
  4353. - int GetNumWheels()
  4354. - Node* GetWheelNode(int wheel)
  4355. - float GetSteeringValue(int wheel) const
  4356. - float GetWheelSuspensionStiffness(int wheel) const
  4357. - float GetWheelDampingRelaxation(int wheel) const
  4358. - float GetWheelDampingCompression(int wheel) const
  4359. - float GetWheelFrictionSlip(int wheel) const
  4360. - float GetWheelRollInfluence(int wheel) const
  4361. - float GetEngineForce(int wheel) const
  4362. - float GetBrake(int wheel) const
  4363. - float GetWheelRadius(int wheel) const
  4364. - float GetWheelRestLength(int wheel) const
  4365. - float GetWheelSkidInfo(int wheel) const
  4366. - float GetMaxSuspensionTravel(int wheel)
  4367. - float GetWheelSideSlipSpeed(int wheel) const
  4368. - float GetMaxSideSlipSpeed() const
  4369. - float GetWheelSkidInfoCumulative(int wheel) const
  4370. - Vector3 GetWheelDirection(int wheel) const
  4371. - bool IsFrontWheel(int wheel) const
  4372. - Vector3 GetWheelAxle(int wheel) const
  4373. - Vector3 GetContactPosition(int wheel) const
  4374. - Vector3 GetContactNormal(int wheel) const
  4375. - float GetInAirRPM() const
  4376. <a name="Class_Rect"></a>
  4377. ### Rect
  4378. Methods:
  4379. - Rect() (GC)
  4380. - Rect* new()
  4381. - Rect(const Rect& rect) (GC)
  4382. - Rect* new(const Rect& rect)
  4383. - Rect(const Vector2& min, const Vector2& max) (GC)
  4384. - Rect* new(const Vector2& min, const Vector2& max)
  4385. - Rect(float left, float top, float right, float bottom) (GC)
  4386. - Rect* new(float left, float top, float right, float bottom)
  4387. - Rect(const Vector4& vector) (GC)
  4388. - Rect* new(const Vector4& vector)
  4389. - void delete()
  4390. - bool operator==(const Rect& rhs) const
  4391. - void Define(const Rect& rect)
  4392. - void Define(const Vector2& min, const Vector2& max)
  4393. - void Define(const Vector2& point)
  4394. - void Merge(const Vector2& point)
  4395. - void Merge(const Rect& rect)
  4396. - void Clear()
  4397. - void Clip(const Rect& rect)
  4398. - bool Defined() const
  4399. - Vector2 Center() const
  4400. - Vector2 Size() const
  4401. - Vector2 HalfSize() const
  4402. - bool Equals(const Rect& rhs) const
  4403. - Intersection IsInside(const Vector2& point) const
  4404. - Intersection IsInside(const Rect& rect) const
  4405. - Vector4 ToVector4() const
  4406. - String ToString() const
  4407. Properties:
  4408. - Vector2 min
  4409. - Vector2 max
  4410. - const Rect FULL
  4411. - const Rect POSITIVE
  4412. - const Rect ZERO
  4413. - Vector2 center (readonly)
  4414. - Vector2 size (readonly)
  4415. - Vector2 halfSize (readonly)
  4416. <a name="Class_RemoteEvent"></a>
  4417. ### RemoteEvent
  4418. Properties:
  4419. - unsigned senderID
  4420. - StringHash eventType
  4421. - VariantMap eventData
  4422. - bool inOrder
  4423. <a name="Class_RenderPath"></a>
  4424. ### RenderPath
  4425. Methods:
  4426. - RenderPath* Clone()
  4427. - bool Load(XMLFile* file)
  4428. - bool Append(XMLFile* file)
  4429. - void SetEnabled(const String tag, bool active)
  4430. - void ToggleEnabled(const String tag)
  4431. - void SetRenderTarget(unsigned index, const RenderTargetInfo& info)
  4432. - void AddRenderTarget(const RenderTargetInfo& info)
  4433. - void RemoveRenderTarget(const String name)
  4434. - void RemoveRenderTarget(unsigned index)
  4435. - void RemoveRenderTargets(const String tag)
  4436. - void SetCommand(unsigned index, const RenderPathCommand& command)
  4437. - void AddCommand(const RenderPathCommand& command)
  4438. - void InsertCommand(unsigned index, const RenderPathCommand& command)
  4439. - void RemoveCommand(unsigned index)
  4440. - void RemoveCommands(const String tag)
  4441. - void SetShaderParameter(const String name, const Variant& value)
  4442. - unsigned GetNumRenderTargets() const
  4443. - unsigned GetNumCommands() const
  4444. - RenderPathCommand* GetCommand(unsigned index)
  4445. - const Variant& GetShaderParameter(const String name) const
  4446. <a name="Class_RenderPathCommand"></a>
  4447. ### RenderPathCommand
  4448. Methods:
  4449. - RenderPathCommand() (GC)
  4450. - RenderPathCommand* new()
  4451. - void Load(const XMLElement& element)
  4452. - void SetTextureName(TextureUnit unit, const String name)
  4453. - void SetShaderParameter(const String name, const Variant& value)
  4454. - void RemoveShaderParameter(const String name)
  4455. - void SetNumOutputs(unsigned num)
  4456. - void SetOutput(unsigned index, const String name, CubeMapFace face)
  4457. - void SetOutputName(unsigned index, const String name)
  4458. - void SetOutputFace(unsigned index, CubeMapFace face)
  4459. - void SetDepthStencilName(const String name)
  4460. - const String GetTextureName(TextureUnit unit) const
  4461. - const Variant& GetShaderParameter(const String name) const
  4462. - unsigned GetNumOutputs() const
  4463. - const String GetOutputName(unsigned index) const
  4464. - CubeMapFace GetOutputFace(unsigned index) const
  4465. - const String GetDepthStencilName() const
  4466. Properties:
  4467. - String tag
  4468. - RenderCommandType type
  4469. - RenderCommandSortMode sortMode
  4470. - String pass
  4471. - String metadata
  4472. - String vertexShaderName
  4473. - String pixelShaderName
  4474. - String vertexShaderDefines
  4475. - String pixelShaderDefines
  4476. - unsigned clearFlags
  4477. - Color clearColor
  4478. - float clearDepth
  4479. - unsigned clearStencil
  4480. - BlendMode blendMode
  4481. - bool enabled
  4482. - bool useFogColor
  4483. - bool markToStencil
  4484. - bool useLitBase
  4485. - bool vertexLights
  4486. - String eventName
  4487. <a name="Class_RenderSurface"></a>
  4488. ### RenderSurface
  4489. Methods:
  4490. - RenderSurface(Texture* parentTexture) (GC)
  4491. - RenderSurface* new(Texture* parentTexture)
  4492. - void delete()
  4493. - void SetNumViewports(unsigned num)
  4494. - void SetViewport(unsigned index, Viewport* viewport)
  4495. - void SetUpdateMode(RenderSurfaceUpdateMode mode)
  4496. - void SetLinkedRenderTarget(RenderSurface* renderTarget)
  4497. - void SetLinkedDepthStencil(RenderSurface* depthStencil)
  4498. - void QueueUpdate()
  4499. - void Release()
  4500. - Texture* GetParentTexture() const
  4501. - int GetWidth() const
  4502. - int GetHeight() const
  4503. - TextureUsage GetUsage() const
  4504. - unsigned GetNumViewports() const
  4505. - Viewport* GetViewport(unsigned index) const
  4506. - RenderSurfaceUpdateMode GetUpdateMode() const
  4507. - RenderSurface* GetLinkedRenderTarget() const
  4508. - RenderSurface* GetLinkedDepthStencil() const
  4509. - bool IsResolveDirty() const
  4510. Properties:
  4511. - Texture* parentTexture (readonly)
  4512. - int width (readonly)
  4513. - int height (readonly)
  4514. - TextureUsage usage (readonly)
  4515. - unsigned numViewports
  4516. - RenderSurfaceUpdateMode updateMode
  4517. - RenderSurface* linkedRenderTarget
  4518. - RenderSurface* linkedDepthStencil
  4519. - bool resolveDirty (readonly)
  4520. <a name="Class_RenderTargetInfo"></a>
  4521. ### RenderTargetInfo
  4522. Methods:
  4523. - RenderTargetInfo() (GC)
  4524. - RenderTargetInfo* new()
  4525. - void Load(const XMLElement& element)
  4526. Properties:
  4527. - String name
  4528. - String tag
  4529. - unsigned format
  4530. - Vector2 size
  4531. - RenderTargetSizeMode sizeMode
  4532. - int multiSample
  4533. - bool autoResolve
  4534. - bool enabled
  4535. - bool cubemap
  4536. - bool filtered
  4537. - bool sRGB
  4538. - bool persistent
  4539. <a name="Class_Renderer"></a>
  4540. ### Renderer
  4541. Methods:
  4542. - void SetNumViewports(unsigned num)
  4543. - void SetViewport(unsigned index, Viewport* viewport)
  4544. - void SetDefaultRenderPath(RenderPath* renderPath)
  4545. - void SetDefaultRenderPath(XMLFile* file)
  4546. - void SetDefaultTechnique(Technique* technique)
  4547. - void SetHDRRendering(bool enable)
  4548. - void SetSpecularLighting(bool enable)
  4549. - void SetTextureAnisotropy(int level)
  4550. - void SetTextureFilterMode(TextureFilterMode mode)
  4551. - void SetTextureQuality(int quality)
  4552. - void SetMaterialQuality(int quality)
  4553. - void SetDrawShadows(bool enable)
  4554. - void SetShadowMapSize(int size)
  4555. - void SetShadowQuality(ShadowQuality quality)
  4556. - void SetShadowSoftness(float shadowSoftness)
  4557. - void SetVSMShadowParameters(float minVariance, float lightBleedingReduction)
  4558. - void SetVSMMultiSample(int multiSample)
  4559. - void SetReuseShadowMaps(bool enable)
  4560. - void SetMaxShadowMaps(int shadowMaps)
  4561. - void SetDynamicInstancing(bool enable)
  4562. - void SetNumExtraInstancingBufferElements(int elements)
  4563. - void SetMinInstances(int instances)
  4564. - void SetMaxSortedInstances(int instances)
  4565. - void SetMaxOccluderTriangles(int triangles)
  4566. - void SetOcclusionBufferSize(int size)
  4567. - void SetOccluderSizeThreshold(float screenSize)
  4568. - void SetThreadedOcclusion(bool enable)
  4569. - void SetMobileShadowBiasMul(float mul)
  4570. - void SetMobileShadowBiasAdd(float add)
  4571. - void SetMobileNormalOffsetMul(float mul)
  4572. - void ReloadShaders()
  4573. - unsigned GetNumViewports() const
  4574. - Viewport* GetViewport(unsigned index) const
  4575. - RenderPath* GetDefaultRenderPath() const
  4576. - Technique* GetDefaultTechnique() const
  4577. - bool GetHDRRendering() const
  4578. - bool GetSpecularLighting() const
  4579. - bool GetDrawShadows() const
  4580. - int GetTextureAnisotropy() const
  4581. - TextureFilterMode GetTextureFilterMode() const
  4582. - int GetTextureQuality() const
  4583. - int GetMaterialQuality() const
  4584. - int GetShadowMapSize() const
  4585. - ShadowQuality GetShadowQuality() const
  4586. - float GetShadowSoftness() const
  4587. - Vector2 GetVSMShadowParameters() const
  4588. - int GetVSMMultiSample() const
  4589. - bool GetReuseShadowMaps() const
  4590. - int GetMaxShadowMaps() const
  4591. - bool GetDynamicInstancing() const
  4592. - int GetNumExtraInstancingBufferElements() const
  4593. - int GetMinInstances() const
  4594. - int GetMaxSortedInstances() const
  4595. - int GetMaxOccluderTriangles() const
  4596. - int GetOcclusionBufferSize() const
  4597. - float GetOccluderSizeThreshold() const
  4598. - bool GetThreadedOcclusion() const
  4599. - float GetMobileShadowBiasMul() const
  4600. - float GetMobileShadowBiasAdd() const
  4601. - float GetMobileNormalOffsetMul() const
  4602. - unsigned GetNumViews() const
  4603. - unsigned GetNumPrimitives() const
  4604. - unsigned GetNumBatches() const
  4605. - unsigned GetNumGeometries(bool allViews = false) const
  4606. - unsigned GetNumLights(bool allViews = false) const
  4607. - unsigned GetNumShadowMaps(bool allViews = false) const
  4608. - unsigned GetNumOccluders(bool allViews = false) const
  4609. - Zone* GetDefaultZone() const
  4610. - Material* GetDefaultMaterial() const
  4611. - Texture2D* GetDefaultLightRamp() const
  4612. - Texture2D* GetDefaultLightSpot() const
  4613. - void DrawDebugGeometry(bool depthTest)
  4614. Properties:
  4615. - unsigned numViewports
  4616. - RenderPath* defaultRenderPath
  4617. - Technique* defaultTechnique
  4618. - bool HDRRendering
  4619. - bool specularLighting
  4620. - bool drawShadows
  4621. - int textureAnisotropy
  4622. - TextureFilterMode textureFilterMode
  4623. - int textureQuality
  4624. - int materialQuality
  4625. - int shadowMapSize
  4626. - ShadowQuality shadowQuality
  4627. - float shadowSoftness
  4628. - int VSMMultiSample
  4629. - bool reuseShadowMaps
  4630. - int maxShadowMaps
  4631. - bool dynamicInstancing
  4632. - int numExtraInstancingBufferElements
  4633. - int minInstances
  4634. - int maxSortedInstances
  4635. - int maxOccluderTriangles
  4636. - int occlusionBufferSize
  4637. - float occluderSizeThreshold
  4638. - bool threadedOcclusion
  4639. - float mobileShadowBiasMul
  4640. - float mobileShadowBiasAdd
  4641. - float mobileNormalOffsetMul
  4642. - unsigned numViews (readonly)
  4643. - unsigned numPrimitives (readonly)
  4644. - unsigned numBatches (readonly)
  4645. - Zone* defaultZone (readonly)
  4646. - Material* defaultMaterial (readonly)
  4647. - Texture2D* defaultLightRamp (readonly)
  4648. - Texture2D* defaultLightSpot (readonly)
  4649. <a name="Class_Resource"></a>
  4650. ### Resource
  4651. Methods:
  4652. - bool Load(Deserializer& source)
  4653. - bool Save(Serializer& dest) const
  4654. - bool Load(const String fileName)
  4655. - bool Save(const String fileName) const
  4656. - const String GetName() const
  4657. - StringHash GetNameHash() const
  4658. - unsigned GetMemoryUse() const
  4659. Properties:
  4660. - String name (readonly)
  4661. - StringHash nameHash (readonly)
  4662. - unsigned memoryUse (readonly)
  4663. <a name="Class_ResourceCache"></a>
  4664. ### ResourceCache
  4665. Methods:
  4666. - void ReleaseAllResources(bool force = false)
  4667. - bool ReloadResource(Resource* resource)
  4668. - void ReloadResourceWithDependencies(const String fileName)
  4669. - void SetMemoryBudget(StringHash type, long budget)
  4670. - void SetMemoryBudget(const String type, long budget)
  4671. - void SetAutoReloadResources(bool enable)
  4672. - void SetReturnFailedResources(bool enable)
  4673. - void SetSearchPackagesFirst(bool value)
  4674. - void SetFinishBackgroundResourcesMs(int ms)
  4675. - File* GetFile(const String name)
  4676. - Resource* GetResource(const String type, const String name, bool sendEventOnFailure = true)
  4677. - Resource* GetExistingResource(const String type, const String name)
  4678. - bool BackgroundLoadResource(const String type, const String name, bool sendEventOnFailure = true)
  4679. - unsigned GetNumBackgroundLoadResources() const
  4680. - const Vector<String>& GetResourceDirs() const
  4681. - bool Exists(const String name) const
  4682. - long GetMemoryBudget(StringHash type) const
  4683. - long GetMemoryUse(StringHash type) const
  4684. - long GetTotalMemoryUse() const
  4685. - String GetResourceFileName(const String name) const
  4686. - bool GetAutoReloadResources() const
  4687. - bool GetReturnFailedResources() const
  4688. - bool GetSearchPackagesFirst() const
  4689. - int GetFinishBackgroundResourcesMs() const
  4690. - String GetPreferredResourceDir(const String path) const
  4691. - String SanitateResourceName(const String name) const
  4692. - String SanitateResourceDirName(const String name) const
  4693. Properties:
  4694. - long totalMemoryUse (readonly)
  4695. - bool autoReloadResources
  4696. - bool returnFailedResources
  4697. - bool searchPackagesFirst
  4698. - unsigned numBackgroundLoadResources (readonly)
  4699. - Vector<String>& resourceDirs (readonly)
  4700. - int finishBackgroundResourcesMs
  4701. <a name="Class_ResourceRef"></a>
  4702. ### ResourceRef
  4703. Methods:
  4704. - ResourceRef() (GC)
  4705. - ResourceRef* new()
  4706. - ResourceRef(StringHash type) (GC)
  4707. - ResourceRef* new(StringHash type)
  4708. - ResourceRef(StringHash type, String name) (GC)
  4709. - ResourceRef* new(StringHash type, String name)
  4710. - ResourceRef(String type, String name) (GC)
  4711. - ResourceRef* new(String type, String name)
  4712. - ResourceRef(const ResourceRef& rhs) (GC)
  4713. - ResourceRef* new(const ResourceRef& rhs)
  4714. - void delete()
  4715. - bool operator==(const ResourceRef& rhs) const
  4716. Properties:
  4717. - StringHash type
  4718. - String name
  4719. <a name="Class_ResourceRefList"></a>
  4720. ### ResourceRefList
  4721. Methods:
  4722. - ResourceRefList() (GC)
  4723. - ResourceRefList* new()
  4724. - ResourceRefList(StringHash type) (GC)
  4725. - ResourceRefList* new(StringHash type)
  4726. - void delete()
  4727. - bool operator==(const ResourceRefList& rhs) const
  4728. Properties:
  4729. - StringHash type
  4730. <a name="Class_RibbonTrail"></a>
  4731. ### RibbonTrail : Drawable
  4732. Methods:
  4733. - void SetMaterial(Material* material)
  4734. - void SetVertexDistance(float length)
  4735. - void SetWidth(float width)
  4736. - void SetStartColor(const Color& c)
  4737. - void SetEndColor(const Color& c)
  4738. - void SetStartScale(float startScale)
  4739. - void SetEndScale(float endScale)
  4740. - void SetTrailType(TrailType type)
  4741. - void SetSorted(bool enable)
  4742. - void SetLifetime(float time)
  4743. - void SetEmitting(bool emitting)
  4744. - void SetUpdateInvisible(bool updateInvisible)
  4745. - void SetTailColumn(unsigned tailColumn)
  4746. - void SetAnimationLodBias(float bias)
  4747. - void Commit()
  4748. - Material* GetMaterial() const
  4749. - float GetVertexDistance() const
  4750. - float GetWidth() const
  4751. - const Color& GetStartColor() const
  4752. - const Color& GetEndColor() const
  4753. - float GetStartScale() const
  4754. - float GetEndScale() const
  4755. - TrailType GetTrailType() const
  4756. - bool IsSorted() const
  4757. - float GetLifetime() const
  4758. - unsigned GetTailColumn() const
  4759. - bool IsEmitting() const
  4760. - bool GetUpdateInvisible() const
  4761. - float GetAnimationLodBias() const
  4762. Properties:
  4763. - Material* material
  4764. - float vertexDistance
  4765. - float width
  4766. - Color& startColor
  4767. - Color& endColor
  4768. - float startScale
  4769. - float endScale
  4770. - TrailType trailType
  4771. - bool sorted
  4772. - float lifetime
  4773. - unsigned tailColumn
  4774. - bool emitting
  4775. - bool updateInvisible
  4776. - float animationLodBias
  4777. <a name="Class_RigidBody"></a>
  4778. ### RigidBody : Component
  4779. Methods:
  4780. - void SetMass(float mass)
  4781. - void SetPosition(const Vector3& position)
  4782. - void SetRotation(const Quaternion& rotation)
  4783. - void SetTransform(const Vector3& position, const Quaternion& rotation)
  4784. - void SetLinearVelocity(const Vector3& velocity)
  4785. - void SetLinearFactor(const Vector3& factor)
  4786. - void SetLinearRestThreshold(float threshold)
  4787. - void SetLinearDamping(float damping)
  4788. - void SetAngularVelocity(const Vector3& angularVelocity)
  4789. - void SetAngularFactor(const Vector3& factor)
  4790. - void SetAngularRestThreshold(float threshold)
  4791. - void SetAngularDamping(float factor)
  4792. - void SetFriction(float friction)
  4793. - void SetAnisotropicFriction(const Vector3& friction)
  4794. - void SetRollingFriction(float friction)
  4795. - void SetRestitution(float restitution)
  4796. - void SetContactProcessingThreshold(float threshold)
  4797. - void SetCcdRadius(float radius)
  4798. - void SetCcdMotionThreshold(float threshold)
  4799. - void SetUseGravity(bool enable)
  4800. - void SetGravityOverride(const Vector3& gravity)
  4801. - void SetKinematic(bool enable)
  4802. - void SetTrigger(bool enable)
  4803. - void SetCollisionLayer(unsigned layer)
  4804. - void SetCollisionMask(unsigned mask)
  4805. - void SetCollisionLayerAndMask(unsigned layer, unsigned mask)
  4806. - void SetCollisionEventMode(CollisionEventMode mode)
  4807. - void DisableMassUpdate()
  4808. - void EnableMassUpdate()
  4809. - void ApplyForce(const Vector3& force)
  4810. - void ApplyForce(const Vector3& force, const Vector3& position)
  4811. - void ApplyTorque(const Vector3& torque)
  4812. - void ApplyImpulse(const Vector3& impulse)
  4813. - void ApplyImpulse(const Vector3& impulse, const Vector3& position)
  4814. - void ApplyTorqueImpulse(const Vector3& torque)
  4815. - void ResetForces()
  4816. - void Activate()
  4817. - void ReAddBodyToWorld()
  4818. - PhysicsWorld* GetPhysicsWorld() const
  4819. - float GetMass() const
  4820. - Vector3 GetPosition() const
  4821. - Quaternion GetRotation() const
  4822. - Vector3 GetLinearVelocity() const
  4823. - Vector3 GetLinearFactor() const
  4824. - Vector3 GetVelocityAtPoint(const Vector3& position) const
  4825. - float GetLinearRestThreshold() const
  4826. - float GetLinearDamping() const
  4827. - Vector3 GetAngularVelocity() const
  4828. - Vector3 GetAngularFactor() const
  4829. - float GetAngularRestThreshold() const
  4830. - float GetAngularDamping() const
  4831. - float GetFriction() const
  4832. - Vector3 GetAnisotropicFriction() const
  4833. - float GetRollingFriction() const
  4834. - float GetRestitution() const
  4835. - float GetContactProcessingThreshold() const
  4836. - float GetCcdRadius() const
  4837. - float GetCcdMotionThreshold() const
  4838. - bool GetUseGravity() const
  4839. - const Vector3& GetGravityOverride() const
  4840. - const Vector3& GetCenterOfMass() const
  4841. - bool IsKinematic() const
  4842. - bool IsTrigger() const
  4843. - bool IsActive() const
  4844. - unsigned GetCollisionLayer() const
  4845. - unsigned GetCollisionMask() const
  4846. - CollisionEventMode GetCollisionEventMode() const
  4847. Properties:
  4848. - PhysicsWorld* physicsWorld (readonly)
  4849. - float mass
  4850. - Vector3 position
  4851. - Quaternion rotation
  4852. - Vector3 linearVelocity
  4853. - Vector3 linearFactor
  4854. - float linearRestThreshold
  4855. - float linearDamping
  4856. - Vector3 angularVelocity
  4857. - Vector3 angularFactor
  4858. - float angularRestThreshold
  4859. - float angularDamping
  4860. - float friction
  4861. - Vector3 anisotropicFriction
  4862. - float rollingFriction
  4863. - float restitution
  4864. - float contactProcessingThreshold
  4865. - float ccdRadius
  4866. - float ccdMotionThreshold
  4867. - bool useGravity
  4868. - Vector3& gravityOverride
  4869. - Vector3& centerOfMass (readonly)
  4870. - bool kinematic
  4871. - bool trigger
  4872. - bool active (readonly)
  4873. - unsigned collisionLayer
  4874. - unsigned collisionMask
  4875. - CollisionEventMode collisionEventMode
  4876. <a name="Class_RigidBody2D"></a>
  4877. ### RigidBody2D : Component
  4878. Methods:
  4879. - void SetBodyType(BodyType2D bodyType)
  4880. - void SetMass(float mass)
  4881. - void SetInertia(float inertia)
  4882. - void SetMassCenter(const Vector2& center)
  4883. - void SetUseFixtureMass(bool useFixtureMass)
  4884. - void SetLinearDamping(float linearDamping)
  4885. - void SetAngularDamping(float angularDamping)
  4886. - void SetAllowSleep(bool allowSleep)
  4887. - void SetFixedRotation(bool fixedRotation)
  4888. - void SetBullet(bool bullet)
  4889. - void SetGravityScale(float gravityScale)
  4890. - void SetAwake(bool awake)
  4891. - void SetLinearVelocity(const Vector2& linearVelocity)
  4892. - void SetAngularVelocity(float angularVelocity)
  4893. - void ApplyForce(const Vector2& force, const Vector2& point, bool wake)
  4894. - void ApplyForceToCenter(const Vector2& force, bool wake)
  4895. - void ApplyTorque(float torque, bool wake)
  4896. - void ApplyLinearImpulse(const Vector2& impulse, const Vector2& point, bool wake)
  4897. - void ApplyLinearImpulseToCenter(const Vector2& impulse, bool wake)
  4898. - void ApplyAngularImpulse(float impulse, bool wake)
  4899. - BodyType2D GetBodyType() const
  4900. - float GetMass() const
  4901. - float GetInertia() const
  4902. - Vector2 GetMassCenter() const
  4903. - bool GetUseFixtureMass() const
  4904. - float GetLinearDamping() const
  4905. - float GetAngularDamping() const
  4906. - bool IsAllowSleep() const
  4907. - bool IsFixedRotation() const
  4908. - bool IsBullet() const
  4909. - float GetGravityScale() const
  4910. - bool IsAwake() const
  4911. - Vector2 GetLinearVelocity() const
  4912. - float GetAngularVelocity() const
  4913. Properties:
  4914. - BodyType2D bodyType
  4915. - float mass
  4916. - float inertia
  4917. - Vector2 massCenter
  4918. - bool useFixtureMass
  4919. - float linearDamping
  4920. - float angularDamping
  4921. - bool allowSleep
  4922. - bool fixedRotation
  4923. - bool bullet
  4924. - float gravityScale
  4925. - bool awake
  4926. - Vector2 linearVelocity
  4927. - float angularVelocity
  4928. <a name="Class_Scene"></a>
  4929. ### Scene : Node
  4930. Methods:
  4931. - Scene() (GC)
  4932. - Scene* new()
  4933. - void delete()
  4934. - bool Load(File* source)
  4935. - bool Save(File* dest) const
  4936. - bool Load(const String fileName)
  4937. - bool Save(const String fileName) const
  4938. - bool LoadXML(File* source)
  4939. - bool SaveXML(File* dest, const String indentation = "\t") const
  4940. - bool LoadXML(const String fileName)
  4941. - bool SaveXML(const String fileName, const String indentation = "\t") const
  4942. - bool LoadJSON(File* source)
  4943. - bool SaveJSON(File* dest, const String indentation = "\t") const
  4944. - bool LoadJSON(const String fileName)
  4945. - bool SaveJSON(const String fileName, const String indentation = "\t") const
  4946. - Node* Instantiate(File* source, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  4947. - Node* Instantiate(const String fileName, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  4948. - Node* InstantiateXML(File* source, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  4949. - Node* InstantiateXML(const String fileName, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  4950. - bool LoadAsync(File* file, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  4951. - bool LoadAsyncXML(File* file, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  4952. - bool LoadAsync(const String fileName, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  4953. - bool LoadAsyncXML(const String fileName, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  4954. - void StopAsyncLoading()
  4955. - void Clear(bool clearReplicated = true, bool clearLocal = true)
  4956. - void SetUpdateEnabled(bool enable)
  4957. - void SetTimeScale(float scale)
  4958. - void SetElapsedTime(float time)
  4959. - void SetSmoothingConstant(float constant)
  4960. - void SetSnapThreshold(float threshold)
  4961. - void SetAsyncLoadingMs(int ms)
  4962. - Node* GetNode(unsigned id) const
  4963. - bool IsUpdateEnabled() const
  4964. - bool IsAsyncLoading() const
  4965. - float GetAsyncProgress() const
  4966. - LoadMode GetAsyncLoadMode() const
  4967. - const String GetFileName() const
  4968. - unsigned GetChecksum() const
  4969. - float GetTimeScale() const
  4970. - float GetElapsedTime() const
  4971. - float GetSmoothingConstant() const
  4972. - float GetSnapThreshold() const
  4973. - int GetAsyncLoadingMs() const
  4974. - const String GetVarName(StringHash hash) const
  4975. - void Update(float timeStep)
  4976. - void BeginThreadedUpdate()
  4977. - void EndThreadedUpdate()
  4978. - void DelayedMarkedDirty(Component* component)
  4979. - bool IsThreadedUpdate() const
  4980. - unsigned GetFreeNodeID(CreateMode mode)
  4981. - unsigned GetFreeComponentID(CreateMode mode)
  4982. - void NodeAdded(Node* node)
  4983. - void NodeRemoved(Node* node)
  4984. - void ComponentAdded(Component* component)
  4985. - void ComponentRemoved(Component* component)
  4986. - void SetVarNamesAttr(const String value)
  4987. - String GetVarNamesAttr() const
  4988. - void PrepareNetworkUpdate()
  4989. - void CleanupConnection(Connection* connection)
  4990. - void MarkNetworkUpdate(Node* node)
  4991. - void MarkNetworkUpdate(Component* component)
  4992. - void MarkReplicationDirty(Node* node)
  4993. - const PODVector<Node*>& GetNodesWithTag(const String tag) const
  4994. Properties:
  4995. - bool updateEnabled
  4996. - bool asyncLoading (readonly)
  4997. - float asyncProgress (readonly)
  4998. - LoadMode asyncLoadMode (readonly)
  4999. - const String fileName
  5000. - unsigned checksum (readonly)
  5001. - float timeScale
  5002. - float elapsedTime
  5003. - float smoothingConstant
  5004. - float snapThreshold
  5005. - int asyncLoadingMs
  5006. - bool threadedUpdate (readonly)
  5007. - String varNamesAttr
  5008. <a name="Class_ScrollBar"></a>
  5009. ### ScrollBar : BorderImage
  5010. Methods:
  5011. - ScrollBar() (GC)
  5012. - ScrollBar* new()
  5013. - void delete()
  5014. - void SetOrientation(Orientation orientation)
  5015. - void SetRange(float range)
  5016. - void SetValue(float value)
  5017. - void ChangeValue(float delta)
  5018. - void SetScrollStep(float step)
  5019. - void SetStepFactor(float factor)
  5020. - void StepBack()
  5021. - void StepForward()
  5022. - Orientation GetOrientation() const
  5023. - float GetRange() const
  5024. - float GetValue() const
  5025. - float GetScrollStep() const
  5026. - float GetStepFactor() const
  5027. - float GetEffectiveScrollStep() const
  5028. - Button* GetBackButton() const
  5029. - Button* GetForwardButton() const
  5030. - Slider* GetSlider() const
  5031. Properties:
  5032. - Orientation orientation
  5033. - float range
  5034. - float value
  5035. - float scrollStep
  5036. - float stepFactor
  5037. - float effectiveScrollStep (readonly)
  5038. - Button* backButton (readonly)
  5039. - Button* forwardButton (readonly)
  5040. - Slider* slider (readonly)
  5041. <a name="Class_ScrollView"></a>
  5042. ### ScrollView : UIElement
  5043. Methods:
  5044. - ScrollView() (GC)
  5045. - ScrollView* new()
  5046. - void delete()
  5047. - void SetContentElement(UIElement* element)
  5048. - void SetViewPosition(const IntVector2& position)
  5049. - void SetViewPosition(int x, int y)
  5050. - void SetScrollBarsVisible(bool horizontal, bool vertical)
  5051. - void SetScrollBarsAutoVisible(bool enable)
  5052. - void SetScrollStep(float step)
  5053. - void SetPageStep(float step)
  5054. - void SetScrollDeceleration(float deceleration)
  5055. - void SetScrollSnapEpsilon(float snap)
  5056. - void SetAutoDisableChildren(bool disable)
  5057. - void SetAutoDisableThreshold(float amount)
  5058. - const IntVector2& GetViewPosition() const
  5059. - UIElement* GetContentElement() const
  5060. - ScrollBar* GetHorizontalScrollBar() const
  5061. - ScrollBar* GetVerticalScrollBar() const
  5062. - BorderImage* GetScrollPanel() const
  5063. - bool GetScrollBarsAutoVisible() const
  5064. - float GetScrollStep() const
  5065. - float GetPageStep() const
  5066. - float GetScrollDeceleration() const
  5067. - float GetScrollSnapEpsilon() const
  5068. - bool GetAutoDisableChildren() const
  5069. - float GetAutoDisableThreshold() const
  5070. Properties:
  5071. - IntVector2& viewPosition
  5072. - UIElement* contentElement
  5073. - ScrollBar* horizontalScrollBar (readonly)
  5074. - ScrollBar* verticalScrollBar (readonly)
  5075. - BorderImage* scrollPanel (readonly)
  5076. - bool scrollBarsAutoVisible
  5077. - float scrollStep
  5078. - float pageStep
  5079. - float scrollDeceleration
  5080. - float scrollSnapEpsilon
  5081. <a name="Class_Serializable"></a>
  5082. ### Serializable : Object
  5083. Methods:
  5084. - void SetTemporary(bool enable)
  5085. - bool IsTemporary() const
  5086. - void SetInterceptNetworkUpdate(const String attributeName, bool enable)
  5087. - bool GetInterceptNetworkUpdate(const String attributeName)
  5088. Properties:
  5089. - bool temporary
  5090. <a name="Class_Serializer"></a>
  5091. ### Serializer
  5092. Methods:
  5093. - unsigned Write(const VectorBuffer& buffer)
  5094. - bool WriteInt(int value)
  5095. - bool WriteInt64(long value)
  5096. - bool WriteShort(short value)
  5097. - bool WriteByte(char value)
  5098. - bool WriteUInt(unsigned value)
  5099. - bool WriteUInt64(long value)
  5100. - bool WriteUShort(short value)
  5101. - bool WriteUByte(char value)
  5102. - bool WriteBool(bool value)
  5103. - bool WriteFloat(float value)
  5104. - bool WriteDouble(double value)
  5105. - bool WriteIntRect(const IntRect& value)
  5106. - bool WriteIntVector2(const IntVector2& value)
  5107. - bool WriteIntVector3(const IntVector3& value)
  5108. - bool WriteRect(const Rect& value)
  5109. - bool WriteVector2(const Vector2& value)
  5110. - bool WriteVector3(const Vector3& value)
  5111. - bool WritePackedVector3(const Vector3& value, float maxAbsCoord)
  5112. - bool WriteVector4(const Vector4& value)
  5113. - bool WriteQuaternion(const Quaternion& value)
  5114. - bool WritePackedQuaternion(const Quaternion& value)
  5115. - bool WriteMatrix3(const Matrix3& value)
  5116. - bool WriteMatrix3x4(const Matrix3x4& value)
  5117. - bool WriteMatrix4(const Matrix4& value)
  5118. - bool WriteColor(const Color& value)
  5119. - bool WriteBoundingBox(const BoundingBox& value)
  5120. - bool WriteString(const String value)
  5121. - bool WriteFileID(const String value)
  5122. - bool WriteStringHash(const StringHash& value)
  5123. - bool WriteBuffer(const VectorBuffer& buffer)
  5124. - bool WriteResourceRef(const ResourceRef& value)
  5125. - bool WriteResourceRefList(const ResourceRefList& value)
  5126. - bool WriteVariant(const Variant& value)
  5127. - bool WriteVariantData(const Variant& value)
  5128. - bool WriteVariantVector(const VariantVector& value)
  5129. - bool WriteVariantMap(const VariantMap& value)
  5130. - bool WriteVLE(unsigned value)
  5131. - bool WriteNetID(unsigned value)
  5132. - bool WriteLine(const String value)
  5133. <a name="Class_Skeleton"></a>
  5134. ### Skeleton
  5135. Methods:
  5136. - unsigned GetNumBones() const
  5137. - Bone* GetRootBone()
  5138. - Bone* GetBone(const String name)
  5139. - Bone* GetBone(unsigned index)
  5140. Properties:
  5141. - unsigned numBones (readonly)
  5142. - Bone* rootBone (readonly)
  5143. <a name="Class_Skybox"></a>
  5144. ### Skybox : StaticModel
  5145. <a name="Class_Slider"></a>
  5146. ### Slider : BorderImage
  5147. Methods:
  5148. - Slider() (GC)
  5149. - Slider* new()
  5150. - void delete()
  5151. - void SetOrientation(Orientation orientation)
  5152. - void SetRange(float range)
  5153. - void SetValue(float value)
  5154. - void ChangeValue(float delta)
  5155. - void SetRepeatRate(float rate)
  5156. - Orientation GetOrientation() const
  5157. - float GetRange() const
  5158. - float GetValue() const
  5159. - BorderImage* GetKnob() const
  5160. - float GetRepeatRate() const
  5161. Properties:
  5162. - Orientation orientation
  5163. - float range
  5164. - float value
  5165. - BorderImage* knob (readonly)
  5166. - float repeatRate
  5167. <a name="Class_Sound"></a>
  5168. ### Sound : Resource
  5169. Methods:
  5170. - Sound() (GC)
  5171. - Sound* new()
  5172. - void delete()
  5173. - bool LoadRaw(Deserializer& source)
  5174. - bool LoadWav(Deserializer& source)
  5175. - bool LoadOggVorbis(Deserializer& source)
  5176. - bool LoadRaw(const String fileName)
  5177. - bool LoadWav(const String fileName)
  5178. - bool LoadOggVorbis(const String fileName)
  5179. - void SetSize(unsigned dataSize)
  5180. - void SetData(const void* data, unsigned dataSize)
  5181. - void SetFormat(unsigned frequency, bool sixteenBit, bool stereo)
  5182. - void SetLooped(bool enable)
  5183. - void SetLoop(unsigned repeatOffset, unsigned endOffset)
  5184. - void FixInterpolation()
  5185. - float GetLength() const
  5186. - unsigned GetDataSize() const
  5187. - unsigned GetSampleSize() const
  5188. - float GetFrequency() const
  5189. - unsigned GetIntFrequency() const
  5190. - bool IsLooped() const
  5191. - bool IsSixteenBit() const
  5192. - bool IsStereo() const
  5193. - bool IsCompressed() const
  5194. Properties:
  5195. - float length (readonly)
  5196. - unsigned dataSize (readonly)
  5197. - unsigned sampleSize (readonly)
  5198. - float frequency (readonly)
  5199. - int intFrequency (readonly)
  5200. - bool looped
  5201. - bool sixteenBit (readonly)
  5202. - bool stereo (readonly)
  5203. - bool compressed (readonly)
  5204. <a name="Class_SoundListener"></a>
  5205. ### SoundListener : Component
  5206. <a name="Class_SoundSource"></a>
  5207. ### SoundSource : Component
  5208. Methods:
  5209. - void Seek(float seekTime)
  5210. - void Play(Sound* sound)
  5211. - void Play(Sound* sound, float frequency)
  5212. - void Play(Sound* sound, float frequency, float gain)
  5213. - void Play(Sound* sound, float frequency, float gain, float panning)
  5214. - void Stop()
  5215. - void SetSoundType(const String type)
  5216. - void SetFrequency(float frequency)
  5217. - void SetGain(float gain)
  5218. - void SetAttenuation(float attenuation)
  5219. - void SetPanning(float panning)
  5220. - void SetAutoRemoveMode(AutoRemoveMode mode)
  5221. - Sound* GetSound() const
  5222. - String GetSoundType() const
  5223. - float GetTimePosition() const
  5224. - float GetFrequency() const
  5225. - float GetGain() const
  5226. - float GetAttenuation() const
  5227. - float GetPanning() const
  5228. - AutoRemoveMode GetAutoRemoveMode() const
  5229. - bool IsPlaying() const
  5230. Properties:
  5231. - Sound* sound (readonly)
  5232. - String soundType
  5233. - float timePosition (readonly)
  5234. - float frequency
  5235. - float gain
  5236. - float attenuation
  5237. - float panning
  5238. - AutoRemoveMode autoRemoveMode
  5239. - bool playing (readonly)
  5240. <a name="Class_SoundSource3D"></a>
  5241. ### SoundSource3D : SoundSource
  5242. Methods:
  5243. - void SetDistanceAttenuation(float nearDistance, float farDistance, float rolloffFactor)
  5244. - void SetAngleAttenuation(float innerAngle, float outerAngle)
  5245. - void SetNearDistance(float distance)
  5246. - void SetFarDistance(float distance)
  5247. - void SetInnerAngle(float angle)
  5248. - void SetOuterAngle(float angle)
  5249. - void SetRolloffFactor(float factor)
  5250. - void CalculateAttenuation()
  5251. - float GetNearDistance() const
  5252. - float GetFarDistance() const
  5253. - float GetInnerAngle() const
  5254. - float GetOuterAngle() const
  5255. - float RollAngleoffFactor() const
  5256. Properties:
  5257. - float nearDistance
  5258. - float farDistance
  5259. - float innerAngle
  5260. - float outerAngle
  5261. - float rolloffFactor
  5262. <a name="Class_Sphere"></a>
  5263. ### Sphere
  5264. Methods:
  5265. - Sphere() (GC)
  5266. - Sphere* new()
  5267. - Sphere(const Sphere& sphere) (GC)
  5268. - Sphere* new(const Sphere& sphere)
  5269. - Sphere(const Vector3& center, float radius) (GC)
  5270. - Sphere* new(const Vector3& center, float radius)
  5271. - Sphere(const BoundingBox& box) (GC)
  5272. - Sphere* new(const BoundingBox& box)
  5273. - Sphere(const Frustum& frustum) (GC)
  5274. - Sphere* new(const Frustum& frustum)
  5275. - Sphere(const Polyhedron& poly) (GC)
  5276. - Sphere* new(const Polyhedron& poly)
  5277. - void delete()
  5278. - bool operator==(const Sphere& rhs) const
  5279. - void Define(const Sphere& sphere)
  5280. - void Define(const Vector3& center, float radius)
  5281. - void Define(const BoundingBox& box)
  5282. - void Define(const Frustum& frustum)
  5283. - void Define(const Polyhedron& poly)
  5284. - void Merge(const Vector3& point)
  5285. - void Merge(const BoundingBox& box)
  5286. - void Merge(const Frustum& frustum)
  5287. - void Merge(const Polyhedron& poly)
  5288. - void Merge(const Sphere& sphere)
  5289. - void Clear()
  5290. - bool Defined() const
  5291. - Intersection IsInside(const Vector3& point) const
  5292. - Intersection IsInside(const Sphere& sphere) const
  5293. - Intersection IsInsideFast(const Sphere& sphere) const
  5294. - Intersection IsInside(const BoundingBox& box) const
  5295. - Intersection IsInsideFast(const BoundingBox& box) const
  5296. - float Distance(const Vector3& point) const
  5297. Properties:
  5298. - Vector3 center
  5299. - float radius
  5300. <a name="Class_Spline"></a>
  5301. ### Spline
  5302. Methods:
  5303. - Spline() (GC)
  5304. - Spline* new()
  5305. - Spline(InterpolationMode mode) (GC)
  5306. - Spline* new(InterpolationMode mode)
  5307. - Spline(const Spline& rhs) (GC)
  5308. - Spline* new(const Spline& rhs)
  5309. - void delete()
  5310. - bool operator==(const Spline& rhs) const
  5311. - Variant GetPoint(float f) const
  5312. - Variant GetKnot(unsigned index) const
  5313. - void SetKnot(const Variant& knot, unsigned tolua_var_1)
  5314. - void AddKnot(const Variant& knot)
  5315. - void AddKnot(const Variant& knot, unsigned index)
  5316. - void RemoveKnot()
  5317. - void RemoveKnot(unsigned index)
  5318. - void Clear()
  5319. Properties:
  5320. - InterpolationMode interpolationMode
  5321. <a name="Class_SplinePath"></a>
  5322. ### SplinePath : Component
  5323. Methods:
  5324. - void AddControlPoint(Node* point, unsigned index = M_MAX_UNSIGNED)
  5325. - void RemoveControlPoint(Node* point)
  5326. - void ClearControlPoints()
  5327. - void SetInterpolationMode(InterpolationMode mode)
  5328. - void SetPosition(float factor)
  5329. - void SetControlledNode(Node* controlled)
  5330. - InterpolationMode GetInterpolationMode() const
  5331. - float GetSpeed() const
  5332. - float GetLength() const
  5333. - Vector3 GetPosition() const
  5334. - Node* GetControlledNode() const
  5335. - Vector3 GetPoint(float factor) const
  5336. - void Move(float timeStep)
  5337. - void Reset()
  5338. - bool IsFinished() const
  5339. Properties:
  5340. - InterpolationMode interpolationMode
  5341. - float speed
  5342. - float length (readonly)
  5343. - Node* controlledNode
  5344. <a name="Class_Sprite"></a>
  5345. ### Sprite : UIElement
  5346. Methods:
  5347. - Sprite() (GC)
  5348. - Sprite* new()
  5349. - void delete()
  5350. - void SetPosition(const Vector2& position)
  5351. - void SetPosition(float x, float y)
  5352. - void SetHotSpot(const IntVector2& hotSpot)
  5353. - void SetHotSpot(int x, int y)
  5354. - void SetScale(const Vector2& scale)
  5355. - void SetScale(float x, float y)
  5356. - void SetScale(float scale)
  5357. - void SetRotation(float angle)
  5358. - void SetTexture(Texture* texture)
  5359. - void SetImageRect(const IntRect& rect)
  5360. - void SetFullImageRect()
  5361. - void SetBlendMode(BlendMode mode)
  5362. - const Vector2& GetPosition() const
  5363. - const IntVector2& GetHotSpot() const
  5364. - const Vector2& GetScale() const
  5365. - float GetRotation() const
  5366. - Texture* GetTexture() const
  5367. - const IntRect& GetImageRect() const
  5368. - BlendMode GetBlendMode() const
  5369. - const Matrix3x4& GetTransform() const
  5370. Properties:
  5371. - Vector2& position
  5372. - IntVector2& hotSpot
  5373. - Vector2& scale
  5374. - float rotation
  5375. - Texture* texture
  5376. - IntRect& imageRect
  5377. - BlendMode blendMode
  5378. - Matrix3x4& transform (readonly)
  5379. <a name="Class_Sprite2D"></a>
  5380. ### Sprite2D : Resource
  5381. Methods:
  5382. - void SetTexture(Texture2D* texture)
  5383. - void SetRectangle(const IntRect& rectangle)
  5384. - void SetHotSpot(const Vector2& hotSpot)
  5385. - void SetOffset(const IntVector2& offset)
  5386. - void SetTextureEdgeOffset(float offset)
  5387. - void SetSpriteSheet(SpriteSheet2D* spriteSheet)
  5388. - Texture2D* GetTexture() const
  5389. - const IntRect& GetRectangle() const
  5390. - const Vector2& GetHotSpot() const
  5391. - const IntVector2& GetOffset() const
  5392. - float GetTextureEdgeOffset() const
  5393. - SpriteSheet2D* GetSpriteSheet() const
  5394. Properties:
  5395. - Texture2D* texture
  5396. - IntRect rectangle
  5397. - Vector2 hotSpot
  5398. - IntVector2 offset
  5399. - float textureEdgeOffset
  5400. - SpriteSheet2D* spriteSheet
  5401. <a name="Class_SpriteSheet2D"></a>
  5402. ### SpriteSheet2D : Resource
  5403. Methods:
  5404. - void SetTexture(Texture2D* texture)
  5405. - Texture2D* GetTexture() const
  5406. - Sprite2D* GetSprite(const String name) const
  5407. - void DefineSprite(const String name, const IntRect& rectangle)
  5408. - void DefineSprite(const String name, const IntRect& rectangle, const Vector2& hotSpot)
  5409. - void DefineSprite(const String name, const IntRect& rectangle, const Vector2& hotSpot, const IntVector2& originSize)
  5410. Properties:
  5411. - Texture2D* texture
  5412. <a name="Class_StaticModel"></a>
  5413. ### StaticModel : Drawable
  5414. Methods:
  5415. - void SetModel(Model* model)
  5416. - void SetMaterial(Material* material)
  5417. - bool SetMaterial(unsigned index, Material* material)
  5418. - void SetOcclusionLodLevel(unsigned level)
  5419. - void ApplyMaterialList(const String fileName = String::EMPTY)
  5420. - Model* GetModel() const
  5421. - unsigned GetNumGeometries() const
  5422. - Material* GetMaterial(unsigned index = 0) const
  5423. - unsigned GetOcclusionLodLevel() const
  5424. - bool IsInside(const Vector3& point) const
  5425. - bool IsInsideLocal(const Vector3& point) const
  5426. Properties:
  5427. - Model* model
  5428. - Material* material
  5429. - BoundingBox& boundingBox (readonly)
  5430. - unsigned numGeometries (readonly)
  5431. - unsigned occlusionLodLevel
  5432. <a name="Class_StaticModelGroup"></a>
  5433. ### StaticModelGroup : StaticModel
  5434. Methods:
  5435. - void AddInstanceNode(Node* node)
  5436. - void RemoveInstanceNode(Node* node)
  5437. - void RemoveAllInstanceNodes()
  5438. - unsigned GetNumInstanceNodes() const
  5439. - Node* GetInstanceNode(unsigned index) const
  5440. Properties:
  5441. - unsigned numInstanceNodes (readonly)
  5442. <a name="Class_StaticSprite2D"></a>
  5443. ### StaticSprite2D : Drawable2D
  5444. Methods:
  5445. - void SetSprite(Sprite2D* sprite)
  5446. - void SetBlendMode(BlendMode mode)
  5447. - void SetFlip(bool flipX, bool flipY)
  5448. - void SetFlipX(bool flipX)
  5449. - void SetFlipY(bool flipY)
  5450. - void SetColor(const Color& color)
  5451. - void SetAlpha(float alpha)
  5452. - void SetUseHotSpot(bool useHotSpot)
  5453. - void SetHotSpot(const Vector2& hotspot)
  5454. - void SetUseDrawRect(bool useDrawRect)
  5455. - void SetDrawRect(const Rect& rect)
  5456. - void SetUseTextureRect(bool useTextureRect)
  5457. - void SetTextureRect(const Rect& rect)
  5458. - void SetCustomMaterial(Material* customMaterial)
  5459. - Sprite2D* GetSprite() const
  5460. - BlendMode GetBlendMode() const
  5461. - bool GetFlipX() const
  5462. - bool GetFlipY() const
  5463. - const Color& GetColor() const
  5464. - float GetAlpha() const
  5465. - bool GetUseHotSpot() const
  5466. - const Vector2& GetHotSpot() const
  5467. - bool GetUseDrawRect() const
  5468. - const Rect& GetDrawRect() const
  5469. - bool GetUseTextureRect() const
  5470. - const Rect& GetTextureRect() const
  5471. - Material* GetCustomMaterial() const
  5472. Properties:
  5473. - Sprite2D* sprite
  5474. - BlendMode blendMode
  5475. - bool flipX
  5476. - bool flipY
  5477. - Color& color
  5478. - float alpha
  5479. - bool useHotSpot
  5480. - Vector2 hotSpot
  5481. - Material* customMaterial
  5482. - Rect drawRect
  5483. - bool useDrawRect
  5484. - Rect textureRect
  5485. - bool useTextureRect
  5486. <a name="Class_StringHash"></a>
  5487. ### StringHash
  5488. Methods:
  5489. - StringHash() (GC)
  5490. - StringHash* new()
  5491. - StringHash(const StringHash& rhs) (GC)
  5492. - StringHash* new(const StringHash& rhs)
  5493. - StringHash(const char* str) (GC)
  5494. - StringHash* new(const char* str)
  5495. - StringHash(unsigned value) (GC)
  5496. - StringHash* new(unsigned value)
  5497. - void delete()
  5498. - StringHash operator+(const StringHash& rhs) const
  5499. - bool operator==(const StringHash& rhs) const
  5500. - bool operator<(const StringHash& rhs) const
  5501. - bool operatorbool() const
  5502. - unsigned Value() const
  5503. - String ToString() const
  5504. - unsigned ToHash() const
  5505. - unsigned Calculate(const char* str)
  5506. Properties:
  5507. - const StringHash ZERO
  5508. - unsigned value (readonly)
  5509. <a name="Class_Technique"></a>
  5510. ### Technique : Resource
  5511. Methods:
  5512. - void SetIsDesktop(bool enable)
  5513. - Pass* CreatePass(const String passName)
  5514. - void RemovePass(const String passName)
  5515. - void ReleaseShaders()
  5516. - Technique* Clone(const String cloneName = String::EMPTY) const
  5517. - bool HasPass(const String type) const
  5518. - Pass* GetPass(const String type) const
  5519. - Pass* GetSupportedPass(const String type) const
  5520. - bool IsSupported() const
  5521. - bool IsDesktop() const
  5522. - unsigned GetNumPasses() const
  5523. - const Vector<String>& GetPassTypes() const
  5524. - const PODVector<Pass*>& GetPasses() const
  5525. Properties:
  5526. - bool supported (readonly)
  5527. - bool desktop (readonly)
  5528. - unsigned numPasses (readonly)
  5529. <a name="Class_Terrain"></a>
  5530. ### Terrain : Component
  5531. Methods:
  5532. - void SetPatchSize(int size)
  5533. - void SetSpacing(const Vector3& spacing)
  5534. - void SetMaxLodLevels(unsigned levels)
  5535. - void SetOcclusionLodLevel(unsigned level)
  5536. - void SetSmoothing(bool enable)
  5537. - bool SetHeightMap(Image* image)
  5538. - void SetMaterial(Material* material)
  5539. - void SetNorthNeighbor(Terrain* north)
  5540. - void SetSouthNeighbor(Terrain* south)
  5541. - void SetWestNeighbor(Terrain* west)
  5542. - void SetEastNeighbor(Terrain* east)
  5543. - void SetNeighbors(Terrain* north, Terrain* south, Terrain* west, Terrain* east)
  5544. - void SetDrawDistance(float distance)
  5545. - void SetShadowDistance(float distance)
  5546. - void SetLodBias(float bias)
  5547. - void SetViewMask(unsigned mask)
  5548. - void SetLightMask(unsigned mask)
  5549. - void SetShadowMask(unsigned mask)
  5550. - void SetZoneMask(unsigned mask)
  5551. - void SetMaxLights(unsigned num)
  5552. - void SetCastShadows(bool enable)
  5553. - void SetOccluder(bool enable)
  5554. - void SetOccludee(bool enable)
  5555. - void ApplyHeightMap()
  5556. - int GetPatchSize() const
  5557. - const Vector3& GetSpacing() const
  5558. - const IntVector2& GetNumVertices() const
  5559. - const IntVector2& GetNumPatches() const
  5560. - unsigned GetMaxLodLevels() const
  5561. - unsigned GetOcclusionLodLevel() const
  5562. - bool GetSmoothing() const
  5563. - Image* GetHeightMap() const
  5564. - Material* GetMaterial() const
  5565. - Terrain* GetNorthNeighbor() const
  5566. - Terrain* GetSouthNeighbor() const
  5567. - Terrain* GetWestNeighbor() const
  5568. - Terrain* GetEastNeighbor() const
  5569. - TerrainPatch* GetPatch(unsigned index) const
  5570. - TerrainPatch* GetPatch(int x, int z) const
  5571. - TerrainPatch* GetNeighborPatch(int x, int z) const
  5572. - float GetHeight(const Vector3& worldPosition) const
  5573. - Vector3 GetNormal(const Vector3& worldPosition) const
  5574. - IntVector2 WorldToHeightMap(const Vector3& worldPosition) const
  5575. - SharedArrayPtr<float> GetHeightData() const
  5576. - float GetDrawDistance() const
  5577. - float GetShadowDistance() const
  5578. - float GetLodBias() const
  5579. - unsigned GetViewMask() const
  5580. - unsigned GetLightMask() const
  5581. - unsigned GetShadowMask() const
  5582. - unsigned GetZoneMask() const
  5583. - unsigned GetMaxLights() const
  5584. - bool IsVisible() const
  5585. - bool GetCastShadows() const
  5586. - bool IsOccluder() const
  5587. - bool IsOccludee() const
  5588. Properties:
  5589. - int patchSize
  5590. - Vector3& spacing
  5591. - IntVector2& numVertices (readonly)
  5592. - IntVector2& numPatches (readonly)
  5593. - unsigned maxLodLevels
  5594. - unsigned occlusionLodLevel
  5595. - bool smoothing
  5596. - Image* heightMap
  5597. - Material* material
  5598. - Terrain* northNeighbor
  5599. - Terrain* southNeighbor
  5600. - Terrain* westNeighbor
  5601. - Terrain* eastNeighbor
  5602. - float drawDistance
  5603. - float shadowDistance
  5604. - float lodBias
  5605. - unsigned viewMask
  5606. - unsigned lightMask
  5607. - unsigned shadowMask
  5608. - unsigned zoneMask
  5609. - unsigned maxLights
  5610. - bool visible (readonly)
  5611. - bool castShadows
  5612. - bool occluder
  5613. - bool occludee
  5614. <a name="Class_TerrainPatch"></a>
  5615. ### TerrainPatch : Drawable
  5616. Methods:
  5617. - void SetOwner(Terrain* terrain)
  5618. - void SetNeighbors(TerrainPatch* north, TerrainPatch* south, TerrainPatch* west, TerrainPatch* east)
  5619. - void SetMaterial(Material* material)
  5620. - void SetBoundingBox(const BoundingBox& box)
  5621. - void SetCoordinates(const IntVector2& coordinates)
  5622. - void ResetLod()
  5623. - Geometry* GetGeometry() const
  5624. - Geometry* GetMaxLodGeometry() const
  5625. - Geometry* GetOcclusionGeometry() const
  5626. - VertexBuffer* GetVertexBuffer() const
  5627. - Terrain* GetOwner() const
  5628. - TerrainPatch* GetNorthPatch() const
  5629. - TerrainPatch* GetSouthPatch() const
  5630. - TerrainPatch* GetWestPatch() const
  5631. - TerrainPatch* GetEastPatch() const
  5632. - const IntVector2& GetCoordinates() const
  5633. - unsigned GetLodLevel() const
  5634. Properties:
  5635. - Geometry* geometry (readonly)
  5636. - Geometry* maxLodGeometry (readonly)
  5637. - Geometry* occlusionGeometry (readonly)
  5638. - VertexBuffer* vertexBuffer (readonly)
  5639. - Terrain* owner
  5640. - TerrainPatch* northPatch (readonly)
  5641. - TerrainPatch* southPatch (readonly)
  5642. - TerrainPatch* westPatch (readonly)
  5643. - TerrainPatch* eastPatch (readonly)
  5644. - BoundingBox& boundingBox
  5645. - IntVector2& coordinates
  5646. - unsigned lodLevel (readonly)
  5647. <a name="Class_Text"></a>
  5648. ### Text : UIElement
  5649. Methods:
  5650. - Text() (GC)
  5651. - Text* new()
  5652. - void delete()
  5653. - bool SetFont(const String fontName, int size = DEFAULT_FONT_SIZE)
  5654. - bool SetFont(Font* font, int size = DEFAULT_FONT_SIZE)
  5655. - bool SetFontSize(int size)
  5656. - void SetText(const String text)
  5657. - void SetTextAlignment(HorizontalAlignment align)
  5658. - void SetRowSpacing(float spacing)
  5659. - void SetWordwrap(bool enable)
  5660. - void SetSelection(unsigned start, unsigned length = M_MAX_UNSIGNED)
  5661. - void ClearSelection()
  5662. - void SetSelectionColor(const Color& color)
  5663. - void SetHoverColor(const Color& color)
  5664. - void SetTextEffect(TextEffect textEffect)
  5665. - void SetEffectShadowOffset(const IntVector2& offset)
  5666. - void SetEffectStrokeThickness(int thickness)
  5667. - void SetEffectRoundStroke(bool roundStroke)
  5668. - void SetEffectColor(const Color& effectColor)
  5669. - bool GetAutoLocalizable() const
  5670. - void SetAutoLocalizable(bool enable)
  5671. - Font* GetFont() const
  5672. - int GetFontSize() const
  5673. - const String GetText() const
  5674. - HorizontalAlignment GetTextAlignment() const
  5675. - float GetRowSpacing() const
  5676. - bool GetWordwrap() const
  5677. - unsigned GetSelectionStart() const
  5678. - unsigned GetSelectionLength() const
  5679. - const Color& GetSelectionColor() const
  5680. - const Color& GetHoverColor() const
  5681. - TextEffect GetTextEffect() const
  5682. - const IntVector2& GetEffectShadowOffset() const
  5683. - int GetEffectStrokeThickness() const
  5684. - bool GetEffectRoundStroke() const
  5685. - const Color& GetEffectColor() const
  5686. - int GetRowHeight() const
  5687. - unsigned GetNumRows() const
  5688. - unsigned GetNumChars() const
  5689. - int GetRowWidth(unsigned index) const
  5690. - IntVector2 GetCharPosition(unsigned index)
  5691. - IntVector2 GetCharSize(unsigned index)
  5692. - void SetEffectDepthBias(float bias)
  5693. - float GetEffectDepthBias() const
  5694. Properties:
  5695. - Font* font
  5696. - int fontSize
  5697. - String text
  5698. - HorizontalAlignment textAlignment
  5699. - float rowSpacing
  5700. - bool wordwrap
  5701. - bool autoLocalizable
  5702. - unsigned selectionStart (readonly)
  5703. - unsigned selectionLength (readonly)
  5704. - Color& selectionColor
  5705. - Color& hoverColor
  5706. - TextEffect textEffect
  5707. - IntVector2& effectShadowOffset
  5708. - int effectStrokeThickness
  5709. - bool effectRoundStroke
  5710. - Color& effectColor
  5711. - int rowHeight (readonly)
  5712. - unsigned numRows (readonly)
  5713. - unsigned numChars (readonly)
  5714. <a name="Class_Text3D"></a>
  5715. ### Text3D : Drawable
  5716. Methods:
  5717. - Text3D() (GC)
  5718. - Text3D* new()
  5719. - void delete()
  5720. - bool SetFont(const String fontName, int size = DEFAULT_FONT_SIZE)
  5721. - bool SetFont(Font* font, int size = DEFAULT_FONT_SIZE)
  5722. - bool SetFontSize(int size)
  5723. - void SetMaterial(Material* material)
  5724. - void SetText(const String text)
  5725. - void SetAlignment(HorizontalAlignment hAlign, VerticalAlignment vAlign)
  5726. - void SetHorizontalAlignment(HorizontalAlignment align)
  5727. - void SetVerticalAlignment(VerticalAlignment align)
  5728. - void SetTextAlignment(HorizontalAlignment align)
  5729. - void SetRowSpacing(float spacing)
  5730. - void SetWordwrap(bool enable)
  5731. - void SetTextEffect(TextEffect textEffect)
  5732. - void SetEffectShadowOffset(const IntVector2& offset)
  5733. - void SetEffectStrokeThickness(int thickness)
  5734. - void SetEffectRoundStroke(bool roundStroke)
  5735. - void SetEffectColor(const Color& effectColor)
  5736. - void SetEffectDepthBias(float bias)
  5737. - void SetWidth(int width)
  5738. - void SetColor(const Color& color)
  5739. - void SetColor(Corner corner, const Color& color)
  5740. - void SetOpacity(float opacity)
  5741. - void SetFixedScreenSize(bool enable)
  5742. - void SetFaceCameraMode(FaceCameraMode mode)
  5743. - Font* GetFont() const
  5744. - Material* GetMaterial() const
  5745. - int GetFontSize() const
  5746. - const String GetText() const
  5747. - HorizontalAlignment GetTextAlignment() const
  5748. - HorizontalAlignment GetHorizontalAlignment() const
  5749. - VerticalAlignment GetVerticalAlignment() const
  5750. - float GetRowSpacing() const
  5751. - bool GetWordwrap() const
  5752. - TextEffect GetTextEffect() const
  5753. - const IntVector2& GetEffectShadowOffset() const
  5754. - int GetEffectStrokeThickness() const
  5755. - bool GetEffectRoundStroke() const
  5756. - const Color& GetEffectColor() const
  5757. - float GetEffectDepthBias() const
  5758. - int GetWidth() const
  5759. - int GetHeight() const
  5760. - int GetRowHeight() const
  5761. - unsigned GetNumRows() const
  5762. - unsigned GetNumChars() const
  5763. - int GetRowWidth(unsigned index) const
  5764. - IntVector2 GetCharPosition(unsigned index)
  5765. - IntVector2 GetCharSize(unsigned index)
  5766. - const Color& GetColor(Corner corner) const
  5767. - float GetOpacity() const
  5768. - bool IsFixedScreenSize() const
  5769. - FaceCameraMode GetFaceCameraMode() const
  5770. Properties:
  5771. - Font* font
  5772. - Material* material
  5773. - int fontSize
  5774. - String text
  5775. - HorizontalAlignment textAlignment
  5776. - HorizontalAlignment horizontalAlignment
  5777. - VerticalAlignment verticalAlignment
  5778. - float rowSpacing
  5779. - bool wordwrap
  5780. - TextEffect textEffect
  5781. - IntVector2& effectShadowOffset
  5782. - int effectStrokeThickness
  5783. - bool effectRoundStroke
  5784. - Color& effectColor
  5785. - float effectDepthBias
  5786. - int width
  5787. - Color& color
  5788. - int height (readonly)
  5789. - int rowHeight (readonly)
  5790. - unsigned numRows (readonly)
  5791. - unsigned numChars (readonly)
  5792. - float opacity
  5793. - bool fixedScreenSize
  5794. - FaceCameraMode faceCameraMode
  5795. <a name="Class_Texture"></a>
  5796. ### Texture : Resource
  5797. Methods:
  5798. - void SetNumLevels(unsigned levels)
  5799. - void SetFilterMode(TextureFilterMode filter)
  5800. - void SetAddressMode(TextureCoordinate coord, TextureAddressMode address)
  5801. - void SetAnisotropy(unsigned level)
  5802. - void SetBorderColor(const Color& color)
  5803. - void SetSRGB(bool enable)
  5804. - void SetBackupTexture(Texture* texture)
  5805. - void SetMipsToSkip(int quality, int toSkip)
  5806. - unsigned GetFormat() const
  5807. - bool IsCompressed() const
  5808. - unsigned GetLevels() const
  5809. - int GetWidth() const
  5810. - int GetHeight() const
  5811. - TextureFilterMode GetFilterMode() const
  5812. - TextureAddressMode GetAddressMode(TextureCoordinate coord) const
  5813. - unsigned GetAnisotropy() const
  5814. - const Color& GetBorderColor() const
  5815. - bool GetSRGB() const
  5816. - int GetMultiSample() const
  5817. - bool GetAutoResolve() const
  5818. - bool IsResolveDirty() const
  5819. - bool GetLevelsDirty() const
  5820. - Texture* GetBackupTexture() const
  5821. - int GetMipsToSkip(int quality) const
  5822. - int GetLevelWidth(unsigned level) const
  5823. - int GetLevelHeight(unsigned level) const
  5824. - TextureUsage GetUsage() const
  5825. - unsigned GetDataSize(int width, int height) const
  5826. - unsigned GetRowDataSize(int width) const
  5827. - unsigned GetComponents() const
  5828. Properties:
  5829. - unsigned format (readonly)
  5830. - bool compressed (readonly)
  5831. - unsigned levels (readonly)
  5832. - int width (readonly)
  5833. - int height (readonly)
  5834. - unsigned components (readonly)
  5835. - TextureFilterMode filterMode
  5836. - unsigned anisotropy
  5837. - Color& borderColor
  5838. - bool sRGB
  5839. - int multiSample (readonly)
  5840. - bool autoResolve (readonly)
  5841. - bool resolveDirty (readonly)
  5842. - bool levelsDirty (readonly)
  5843. - Texture* backupTexture
  5844. - TextureUsage usage (readonly)
  5845. <a name="Class_Texture2D"></a>
  5846. ### Texture2D : Texture
  5847. Methods:
  5848. - Texture2D() (GC)
  5849. - Texture2D* new()
  5850. - void delete()
  5851. - bool SetSize(int width, int height, unsigned format, TextureUsage usage = TEXTURE_STATIC, int multiSample = 1, bool autoResolve = true)
  5852. - bool SetData(Image* image, bool useAlpha = false)
  5853. - Image* GetImage() const
  5854. - RenderSurface* GetRenderSurface() const
  5855. Properties:
  5856. - RenderSurface* renderSurface (readonly)
  5857. <a name="Class_Texture2DArray"></a>
  5858. ### Texture2DArray : Texture
  5859. Methods:
  5860. - Texture2DArray() (GC)
  5861. - Texture2DArray* new()
  5862. - void delete()
  5863. - void SetLayers(unsigned layers)
  5864. - bool SetSize(unsigned layers, int width, int height, unsigned format, TextureUsage usage = TEXTURE_STATIC)
  5865. - bool SetData(unsigned layer, Image* image, bool useAlpha = false)
  5866. - unsigned GetLayers() const
  5867. - RenderSurface* GetRenderSurface() const
  5868. Properties:
  5869. - unsigned layers
  5870. - RenderSurface* renderSurface (readonly)
  5871. <a name="Class_Texture3D"></a>
  5872. ### Texture3D : Texture
  5873. Methods:
  5874. - Texture3D() (GC)
  5875. - Texture3D* new()
  5876. - void delete()
  5877. - bool SetSize(int width, int height, int depth, unsigned format, TextureUsage usage = TEXTURE_STATIC)
  5878. - bool SetData(Image* image, bool useAlpha = false)
  5879. <a name="Class_TextureCube"></a>
  5880. ### TextureCube : Texture
  5881. Methods:
  5882. - TextureCube() (GC)
  5883. - TextureCube* new()
  5884. - void delete()
  5885. - bool SetSize(int size, unsigned format, TextureUsage usage = TEXTURE_STATIC, int multiSample = 1)
  5886. - bool SetData(CubeMapFace face, Image* image, bool useAlpha = false)
  5887. - Image* GetImage(CubeMapFace face) const
  5888. - RenderSurface* GetRenderSurface(CubeMapFace face) const
  5889. <a name="Class_TextureFrame"></a>
  5890. ### TextureFrame
  5891. Methods:
  5892. - TextureFrame() (GC)
  5893. - TextureFrame* new()
  5894. - void delete()
  5895. Properties:
  5896. - Rect uv
  5897. - float time
  5898. <a name="Class_Tile2D"></a>
  5899. ### Tile2D
  5900. Methods:
  5901. - int GetGid() const
  5902. - Sprite2D* GetSprite() const
  5903. - bool HasProperty(const String name) const
  5904. - const String GetProperty(const String name) const
  5905. Properties:
  5906. - int gid (readonly)
  5907. - Sprite2D* sprite (readonly)
  5908. <a name="Class_TileMap2D"></a>
  5909. ### TileMap2D : Component
  5910. Methods:
  5911. - void SetTmxFile(TmxFile2D* tmxFile)
  5912. - TmxFile2D* GetTmxFile() const
  5913. - const TileMapInfo2D& GetInfo() const
  5914. - unsigned GetNumLayers() const
  5915. - TileMapLayer2D* GetLayer(unsigned index) const
  5916. - Vector2 TileIndexToPosition(int x, int y) const
  5917. - bool PositionToTileIndex(const Vector2& position, int x = 0, int y = 0) const
  5918. Properties:
  5919. - TmxFile2D* tmxFile
  5920. - TileMapInfo2D& info (readonly)
  5921. - unsigned numLayers (readonly)
  5922. <a name="Class_TileMapInfo2D"></a>
  5923. ### TileMapInfo2D
  5924. Methods:
  5925. - float GetMapWidth() const
  5926. - float GetMapHeight() const
  5927. Properties:
  5928. - Orientation2D orientation
  5929. - int width
  5930. - int height
  5931. - float tileWidth
  5932. - float tileHeight
  5933. - float mapWidth (readonly)
  5934. - float mapHeight (readonly)
  5935. <a name="Class_TileMapLayer2D"></a>
  5936. ### TileMapLayer2D : Component
  5937. Methods:
  5938. - void SetDrawOrder(int drawOrder)
  5939. - void SetVisible(bool visible)
  5940. - int GetDrawOrder() const
  5941. - bool IsVisible() const
  5942. - bool HasProperty(const String name) const
  5943. - const String GetProperty(const String name) const
  5944. - TileMapLayerType2D GetLayerType() const
  5945. - int GetWidth() const
  5946. - int GetHeight() const
  5947. - Node* GetTileNode(int x, int y) const
  5948. - Tile2D* GetTile(int x, int y) const
  5949. - unsigned GetNumObjects() const
  5950. - TileMapObject2D* GetObject(unsigned index) const
  5951. - Node* GetObjectNode(unsigned index) const
  5952. - Node* GetImageNode() const
  5953. Properties:
  5954. - int drawOrder (readonly)
  5955. - bool visible (readonly)
  5956. - TileMapLayerType2D layerType (readonly)
  5957. - int width (readonly)
  5958. - int height (readonly)
  5959. - unsigned numObjects (readonly)
  5960. - Node* imageNode (readonly)
  5961. <a name="Class_TileMapObject2D"></a>
  5962. ### TileMapObject2D
  5963. Methods:
  5964. - TileMapObjectType2D GetObjectType() const
  5965. - const String GetName() const
  5966. - const String GetType() const
  5967. - const Vector2& GetPosition() const
  5968. - const Vector2& GetSize() const
  5969. - unsigned GetNumPoints() const
  5970. - const Vector2& GetPoint(unsigned index) const
  5971. - int GetTileGid() const
  5972. - Sprite2D* GetTileSprite() const
  5973. - bool HasProperty(const String name) const
  5974. - const String GetProperty(const String name) const
  5975. Properties:
  5976. - TileMapObjectType2D objectType (readonly)
  5977. - String name (readonly)
  5978. - String type (readonly)
  5979. - Vector2 position (readonly)
  5980. - Vector2 size (readonly)
  5981. - unsigned numPoints (readonly)
  5982. - int tileGid (readonly)
  5983. - Sprite2D* tileSprite (readonly)
  5984. <a name="Class_Time"></a>
  5985. ### Time : Object
  5986. Methods:
  5987. - unsigned GetFrameNumber() const
  5988. - float GetTimeStep() const
  5989. - unsigned GetTimerPeriod() const
  5990. - float GetElapsedTime()
  5991. - unsigned GetSystemTime()
  5992. - unsigned GetTimeSinceEpoch()
  5993. - String GetTimeStamp()
  5994. - void Sleep(unsigned mSec)
  5995. Properties:
  5996. - unsigned frameNumber (readonly)
  5997. - float timeStep (readonly)
  5998. - unsigned timerPeriod (readonly)
  5999. - float elapsedTime (readonly)
  6000. <a name="Class_TmxFile2D"></a>
  6001. ### TmxFile2D : Resource
  6002. <a name="Class_ToolTip"></a>
  6003. ### ToolTip : UIElement
  6004. Methods:
  6005. - ToolTip() (GC)
  6006. - ToolTip* new()
  6007. - void delete()
  6008. - void SetDelay(float delay)
  6009. - float GetDelay() const
  6010. Properties:
  6011. - float delay
  6012. <a name="Class_TouchState"></a>
  6013. ### TouchState
  6014. Methods:
  6015. - UIElement* GetTouchedElement()
  6016. Properties:
  6017. - int touchID
  6018. - IntVector2 position
  6019. - IntVector2 lastPosition
  6020. - IntVector2 delta
  6021. - float pressure
  6022. - UIElement* touchedElement (readonly)
  6023. <a name="Class_UI"></a>
  6024. ### UI : Object
  6025. Methods:
  6026. - void SetCursor(Cursor* cursor)
  6027. - void SetFocusElement(UIElement* element, bool byKey = false)
  6028. - bool SetModalElement(UIElement* modalElement, bool enable)
  6029. - void Clear()
  6030. - void DebugDraw(UIElement* element)
  6031. - UIElement* LoadLayout(File* source, XMLFile* styleFile = 0)
  6032. - UIElement* LoadLayout(const String fileName, XMLFile* styleFile = 0)
  6033. - UIElement* LoadLayout(XMLFile* file, XMLFile* styleFile = 0)
  6034. - bool SaveLayout(Serializer& dest, UIElement* element)
  6035. - void SetClipboardText(const String text)
  6036. - void SetDoubleClickInterval(float interval)
  6037. - void SetDragBeginInterval(float interval)
  6038. - void SetDragBeginDistance(int pixels)
  6039. - void SetDefaultToolTipDelay(float delay)
  6040. - void SetMaxFontTextureSize(int size)
  6041. - void SetNonFocusedMouseWheel(bool nonFocusedMouseWheel)
  6042. - void SetUseSystemClipboard(bool enable)
  6043. - void SetUseScreenKeyboard(bool enable)
  6044. - void SetUseMutableGlyphs(bool enable)
  6045. - void SetForceAutoHint(bool enable)
  6046. - void SetScale(float scale)
  6047. - void SetWidth(float width)
  6048. - void SetHeight(float height)
  6049. - void SetCustomSize(const IntVector2& size)
  6050. - void SetCustomSize(int width, int height)
  6051. - UIElement* GetRoot() const
  6052. - UIElement* GetRootModalElement() const
  6053. - Cursor* GetCursor() const
  6054. - IntVector2 GetCursorPosition() const
  6055. - UIElement* GetElementAt(const IntVector2& position, bool enabledOnly = true)
  6056. - UIElement* GetElementAt(int x, int y, bool enabledOnly = true)
  6057. - UIElement* GetFocusElement() const
  6058. - UIElement* GetFrontElement() const
  6059. - UIElement* GetDragElement(unsigned index)
  6060. - const String GetClipboardText() const
  6061. - float GetDoubleClickInterval() const
  6062. - float GetDragBeginInterval() const
  6063. - int GetDragBeginDistance() const
  6064. - float GetDefaultToolTipDelay() const
  6065. - int GetMaxFontTextureSize() const
  6066. - bool IsNonFocusedMouseWheel() const
  6067. - bool GetUseSystemClipboard() const
  6068. - bool GetUseScreenKeyboard() const
  6069. - bool GetUseMutableGlyphs() const
  6070. - bool GetForceAutoHint() const
  6071. - bool HasModalElement() const
  6072. - bool IsDragging() const
  6073. - float GetScale() const
  6074. - const IntVector2& GetCustomSize() const
  6075. Properties:
  6076. - UIElement* root (readonly)
  6077. - UIElement* rootModalElement (readonly)
  6078. - Cursor* cursor
  6079. - IntVector2 cursorPosition (readonly)
  6080. - UIElement* focusElement (readonly)
  6081. - UIElement* frontElement (readonly)
  6082. - String clipboardText
  6083. - float doubleClickInterval
  6084. - float dragBeginInterval
  6085. - int dragBeginDistance
  6086. - float defaultToolTipDelay
  6087. - int maxFontTextureSize
  6088. - bool nonFocusedMouseWheel
  6089. - bool useSystemClipboard
  6090. - bool useScreenKeyboard
  6091. - bool useMutableGlyphs
  6092. - bool forceAutoHint
  6093. - bool modalElement (readonly)
  6094. - float scale
  6095. - IntVector2& customSize
  6096. <a name="Class_UIElement"></a>
  6097. ### UIElement : Animatable
  6098. Methods:
  6099. - UIElement() (GC)
  6100. - UIElement* new()
  6101. - void delete()
  6102. - const IntVector2& GetScreenPosition() const
  6103. - bool LoadXML(Deserializer& source)
  6104. - bool SaveXML(Serializer& dest, const String indentation = "\t") const
  6105. - bool LoadXML(const String fileName)
  6106. - bool SaveXML(const String fileName, const String indentation = "\t") const
  6107. - bool FilterAttributes(XMLElement& dest) const
  6108. - void SetName(const String name)
  6109. - void SetPosition(const IntVector2& position)
  6110. - void SetPosition(int x, int y)
  6111. - void SetSize(const IntVector2& size)
  6112. - void SetSize(int width, int height)
  6113. - void SetWidth(int width)
  6114. - void SetHeight(int height)
  6115. - void SetMinSize(const IntVector2& minSize)
  6116. - void SetMinSize(int width, int height)
  6117. - void SetMinWidth(int width)
  6118. - void SetMinHeight(int height)
  6119. - void SetMaxSize(const IntVector2& maxSize)
  6120. - void SetMaxSize(int width, int height)
  6121. - void SetMaxWidth(int width)
  6122. - void SetMaxHeight(int height)
  6123. - void SetFixedSize(const IntVector2& size)
  6124. - void SetFixedSize(int width, int height)
  6125. - void SetFixedWidth(int width)
  6126. - void SetFixedHeight(int height)
  6127. - void SetAlignment(HorizontalAlignment hAlign, VerticalAlignment vAlign)
  6128. - void SetHorizontalAlignment(HorizontalAlignment align)
  6129. - void SetVerticalAlignment(VerticalAlignment align)
  6130. - void SetEnableAnchor(bool enable)
  6131. - void SetMinAnchor(const Vector2& anchor)
  6132. - void SetMinAnchor(float x, float y)
  6133. - void SetMaxAnchor(const Vector2& anchor)
  6134. - void SetMaxAnchor(float x, float y)
  6135. - void SetMinOffset(const IntVector2& offset)
  6136. - void SetMaxOffset(const IntVector2& offset)
  6137. - void SetPivot(const Vector2& pivot)
  6138. - void SetPivot(float x, float y)
  6139. - void SetClipBorder(const IntRect& rect)
  6140. - void SetColor(const Color& color)
  6141. - void SetColor(Corner corner, const Color& color)
  6142. - void SetPriority(int priority)
  6143. - void SetOpacity(float opacity)
  6144. - void SetBringToFront(bool enable)
  6145. - void SetBringToBack(bool enable)
  6146. - void SetClipChildren(bool enable)
  6147. - void SetSortChildren(bool enable)
  6148. - void SetUseDerivedOpacity(bool enable)
  6149. - void SetEnabled(bool enable)
  6150. - void SetDeepEnabled(bool enable)
  6151. - void ResetDeepEnabled()
  6152. - void SetEnabledRecursive(bool enable)
  6153. - void SetEditable(bool enable)
  6154. - void SetFocus(bool enable)
  6155. - void SetSelected(bool enable)
  6156. - void SetVisible(bool enable)
  6157. - void SetFocusMode(FocusMode mode)
  6158. - void SetDragDropMode(unsigned mode)
  6159. - bool SetStyle(const String styleName, XMLFile* file = 0)
  6160. - bool SetStyle(const XMLElement& element)
  6161. - bool SetStyleAuto(XMLFile* file = 0)
  6162. - void SetDefaultStyle(XMLFile* style)
  6163. - void SetLayout(LayoutMode mode, int spacing = 0)
  6164. - void SetLayout(LayoutMode mode, int spacing, const IntRect& border)
  6165. - void SetLayoutMode(LayoutMode mode)
  6166. - void SetLayoutSpacing(int spacing)
  6167. - void SetLayoutBorder(const IntRect& border)
  6168. - void SetLayoutFlexScale(const Vector2& scale)
  6169. - void SetIndent(int indent)
  6170. - void SetIndentSpacing(int indentSpacing)
  6171. - void UpdateLayout()
  6172. - void DisableLayoutUpdate()
  6173. - void EnableLayoutUpdate()
  6174. - void BringToFront()
  6175. - UIElement* CreateChild(const String type, const String name = String::EMPTY, unsigned index = M_MAX_UNSIGNED)
  6176. - void AddChild(UIElement* element)
  6177. - void InsertChild(unsigned index, UIElement* element)
  6178. - void RemoveChild(UIElement* element, unsigned index = 0)
  6179. - void RemoveChildAtIndex(unsigned index)
  6180. - void RemoveAllChildren()
  6181. - void Remove()
  6182. - unsigned FindChild(UIElement* element) const
  6183. - void SetParent(UIElement* parent, unsigned index = M_MAX_UNSIGNED)
  6184. - void SetVar(StringHash key, const Variant& value)
  6185. - void SetInternal(bool enable)
  6186. - void SetTraversalMode(TraversalMode traversalMode)
  6187. - void SetElementEventSender(bool flag)
  6188. - void AddTag(const String tag)
  6189. - void AddTags(const String tags, char separator)
  6190. - bool RemoveTag(const String tag)
  6191. - void RemoveAllTags()
  6192. - const String GetName() const
  6193. - const IntVector2& GetPosition() const
  6194. - const IntVector2& GetSize() const
  6195. - int GetWidth() const
  6196. - int GetHeight() const
  6197. - const IntVector2& GetMinSize() const
  6198. - int GetMinWidth() const
  6199. - int GetMinHeight() const
  6200. - const IntVector2& GetMaxSize() const
  6201. - int GetMaxWidth() const
  6202. - int GetMaxHeight() const
  6203. - bool IsFixedSize() const
  6204. - bool IsFixedWidth() const
  6205. - bool IsFixedHeight() const
  6206. - const IntVector2& GetChildOffset() const
  6207. - HorizontalAlignment GetHorizontalAlignment() const
  6208. - VerticalAlignment GetVerticalAlignment() const
  6209. - bool GetEnableAnchor() const
  6210. - const Vector2& GetMinAnchor() const
  6211. - const Vector2& GetMaxAnchor() const
  6212. - const IntVector2& GetMinOffset() const
  6213. - const IntVector2& GetMaxOffset() const
  6214. - const Vector2& GetPivot() const
  6215. - const IntRect& GetClipBorder() const
  6216. - const Color& GetColor(Corner corner) const
  6217. - int GetPriority() const
  6218. - float GetOpacity() const
  6219. - float GetDerivedOpacity() const
  6220. - bool GetBringToFront() const
  6221. - bool GetBringToBack() const
  6222. - bool GetClipChildren() const
  6223. - bool GetSortChildren() const
  6224. - bool GetUseDerivedOpacity() const
  6225. - bool HasFocus() const
  6226. - bool IsEnabled() const
  6227. - bool IsEnabledSelf() const
  6228. - bool IsEditable() const
  6229. - bool IsSelected() const
  6230. - bool IsVisible() const
  6231. - bool IsVisibleEffective() const
  6232. - bool IsHovering() const
  6233. - bool IsInternal() const
  6234. - bool HasColorGradient() const
  6235. - FocusMode GetFocusMode() const
  6236. - unsigned GetDragDropMode() const
  6237. - const String GetAppliedStyle() const
  6238. - XMLFile* GetDefaultStyle(bool recursiveUp = true) const
  6239. - LayoutMode GetLayoutMode() const
  6240. - int GetLayoutSpacing() const
  6241. - const IntRect& GetLayoutBorder() const
  6242. - const Vector2& GetLayoutFlexScale() const
  6243. - unsigned GetNumChildren(bool recursive = false) const
  6244. - int GetDragButtonCombo() const
  6245. - unsigned GetDragButtonCount() const
  6246. - UIElement* GetChild(const String name, bool recursive = false) const
  6247. - UIElement* GetChild(unsigned index) const
  6248. - UIElement* GetParent() const
  6249. - UIElement* GetRoot() const
  6250. - const Color& GetDerivedColor() const
  6251. - const Variant& GetVar(StringHash key) const
  6252. - const VariantMap& GetVars() const
  6253. - bool HasTag(const String tag) const
  6254. - const StringVector& GetTags() const
  6255. - const PODVector<UIElement*>& GetChildrenWithTag(const String tag, bool recursive = false) const
  6256. - IntVector2 ScreenToElement(const IntVector2& screenPosition)
  6257. - IntVector2 ElementToScreen(const IntVector2& position)
  6258. - bool IsInside(IntVector2 position, bool isScreen)
  6259. - bool IsInsideCombined(IntVector2 position, bool isScreen)
  6260. - IntRect GetCombinedScreenRect()
  6261. - void SortChildren()
  6262. - int GetIndent() const
  6263. - int GetIndentSpacing() const
  6264. - int GetIndentWidth() const
  6265. - void SetChildOffset(const IntVector2& offset)
  6266. - void SetHovering(bool enable)
  6267. - const Color& GetColor() const
  6268. - TraversalMode GetTraversalMode() const
  6269. - bool IsElementEventSender() const
  6270. - UIElement* GetElementEventSender() const
  6271. Properties:
  6272. - IntVector2& screenPosition (readonly)
  6273. - String name
  6274. - IntVector2& position
  6275. - IntVector2 size
  6276. - int width
  6277. - int height
  6278. - IntVector2 minSize
  6279. - int minWidth
  6280. - int minHeight
  6281. - IntVector2 maxSize
  6282. - int maxWidth
  6283. - int maxHeight
  6284. - bool fixedSize (readonly)
  6285. - bool fixedWidth (readonly)
  6286. - bool fixedHeight (readonly)
  6287. - IntVector2& childOffset
  6288. - HorizontalAlignment horizontalAlignment
  6289. - VerticalAlignment verticalAlignment
  6290. - bool enableAnchor
  6291. - IntVector2& minOffset
  6292. - IntVector2& maxOffset
  6293. - Vector2& minAnchor
  6294. - Vector2& maxAnchor
  6295. - Vector2& pivot
  6296. - IntRect clipBorder
  6297. - Color& color
  6298. - int priority
  6299. - float opacity
  6300. - float derivedOpacity (readonly)
  6301. - bool bringToFront
  6302. - bool bringToBack
  6303. - bool clipChildren
  6304. - bool sortChildren
  6305. - bool useDerivedOpacity
  6306. - bool focus
  6307. - bool enabled
  6308. - bool enabledSelf (readonly)
  6309. - bool editable
  6310. - bool selected
  6311. - bool visible
  6312. - bool visibleEffective (readonly)
  6313. - bool hovering
  6314. - bool internal
  6315. - bool colorGradient (readonly)
  6316. - FocusMode focusMode
  6317. - unsigned dragDropMode
  6318. - String style
  6319. - XMLFile* defaultStyle
  6320. - LayoutMode layoutMode
  6321. - int layoutSpacing
  6322. - IntRect& layoutBorder
  6323. - Vector2& layoutFlexScale
  6324. - unsigned numChildren (readonly)
  6325. - UIElement* parent
  6326. - UIElement* root (readonly)
  6327. - Color& derivedColor (readonly)
  6328. - IntRect combinedScreenRect (readonly)
  6329. - int indent
  6330. - int indentSpacing
  6331. - int indentWidth (readonly)
  6332. - TraversalMode traversalMode
  6333. - bool elementEventSender
  6334. <a name="Class_ValueAnimation"></a>
  6335. ### ValueAnimation : Resource
  6336. Methods:
  6337. - ValueAnimation() (GC)
  6338. - ValueAnimation* new()
  6339. - void delete()
  6340. - void SetInterpolationMethod(InterpMethod method)
  6341. - void SetSplineTension(float tension)
  6342. - void SetValueType(VariantType valueType)
  6343. - bool SetKeyFrame(float time, const Variant& value)
  6344. - void SetEventFrame(float time, const StringHash& eventType)
  6345. - void SetEventFrame(float time, const StringHash& eventType, const VariantMap& eventData)
  6346. - InterpMethod GetInterpolationMethod() const
  6347. - float GetSplineTension() const
  6348. - VariantType GetValueType() const
  6349. Properties:
  6350. - InterpMethod interpolationMethod
  6351. - float splineTension
  6352. - VariantType valueType
  6353. <a name="Class_Variant"></a>
  6354. ### Variant
  6355. Methods:
  6356. - Variant() (GC)
  6357. - Variant* new()
  6358. - Variant(const Variant& value) (GC)
  6359. - Variant* new(const Variant& value)
  6360. - Variant(const char* type, const char* value) (GC)
  6361. - Variant* new(const char* type, const char* value)
  6362. - Variant(VariantType type, const char* value) (GC)
  6363. - Variant* new(VariantType type, const char* value)
  6364. - void delete()
  6365. - void Clear()
  6366. - bool operator==(const Variant& rhs) const
  6367. - void Set(const Variant& rhs)
  6368. - void* Get(const char* type = 0) const
  6369. - int GetInt() const
  6370. - unsigned GetUInt() const
  6371. - int GetInt64() const
  6372. - int GetUInt64() const
  6373. - StringHash GetStringHash() const
  6374. - bool GetBool() const
  6375. - float GetFloat() const
  6376. - double GetDouble() const
  6377. - const Vector2& GetVector2() const
  6378. - const Vector3& GetVector3() const
  6379. - const Vector4& GetVector4() const
  6380. - const Quaternion& GetQuaternion() const
  6381. - const Color& GetColor() const
  6382. - const String GetString() const
  6383. - const PODVector<unsigned char>& GetRawBuffer() const
  6384. - VectorBuffer GetBuffer() const
  6385. - void* GetVoidPtr(const char* type) const
  6386. - const ResourceRef& GetResourceRef() const
  6387. - const ResourceRefList& GetResourceRefList() const
  6388. - const Vector<Variant>& GetVariantVector() const
  6389. - const VariantMap& GetVariantMap() const
  6390. - const Vector<String>& GetStringVector() const
  6391. - const Rect& GetRect() const
  6392. - const IntRect& GetIntRect() const
  6393. - const IntVector2& GetIntVector2() const
  6394. - const IntVector3& GetIntVector3() const
  6395. - RefCounted* GetPtr(const char* type) const
  6396. - const Matrix3& GetMatrix3() const
  6397. - const Matrix3x4& GetMatrix3x4() const
  6398. - const Matrix4& GetMatrix4() const
  6399. - VariantType GetType() const
  6400. - String GetTypeName() const
  6401. - String ToString() const
  6402. - bool IsZero() const
  6403. - bool IsEmpty() const
  6404. Properties:
  6405. - VariantType type (readonly)
  6406. - String typeName (readonly)
  6407. - bool zero (readonly)
  6408. - bool empty (readonly)
  6409. <a name="Class_VariantMap"></a>
  6410. ### VariantMap
  6411. Methods:
  6412. - VariantMap() (GC)
  6413. - VariantMap* new()
  6414. - void delete()
  6415. <a name="Class_Vector2"></a>
  6416. ### Vector2
  6417. Methods:
  6418. - Vector2() (GC)
  6419. - Vector2* new()
  6420. - Vector2(const Vector2& vector) (GC)
  6421. - Vector2* new(const Vector2& vector)
  6422. - Vector2(const IntVector2& vector) (GC)
  6423. - Vector2* new(const IntVector2& vector)
  6424. - Vector2(float x, float y) (GC)
  6425. - Vector2* new(float x, float y)
  6426. - void delete()
  6427. - bool operator==(const Vector2& rhs) const
  6428. - Vector2 operator+(const Vector2& rhs) const
  6429. - Vector2 operator-() const
  6430. - Vector2 operator-(const Vector2& rhs) const
  6431. - Vector2 operator*(float rhs) const
  6432. - Vector2 operator*(const Vector2& rhs) const
  6433. - Vector2 operator/(float rhs) const
  6434. - Vector2 operator/(const Vector2& rhs) const
  6435. - Vector2 operator/(const Vector2& rhs) const
  6436. - void Normalize()
  6437. - float Length() const
  6438. - float LengthSquared() const
  6439. - float DotProduct(const Vector2& rhs) const
  6440. - float AbsDotProduct(const Vector2& rhs) const
  6441. - float ProjectOntoAxis(const Vector2& axis) const
  6442. - float Angle(const Vector2& rhs) const
  6443. - Vector2 Abs() const
  6444. - Vector2 Lerp(const Vector2& rhs, float t) const
  6445. - bool Equals(const Vector2& rhs) const
  6446. - bool IsNaN() const
  6447. - Vector2 Normalized() const
  6448. - String ToString() const
  6449. Properties:
  6450. - float x
  6451. - float y
  6452. - const Vector2 ZERO
  6453. - const Vector2 LEFT
  6454. - const Vector2 RIGHT
  6455. - const Vector2 UP
  6456. - const Vector2 DOWN
  6457. - const Vector2 ONE
  6458. <a name="Class_Vector3"></a>
  6459. ### Vector3
  6460. Methods:
  6461. - Vector3() (GC)
  6462. - Vector3* new()
  6463. - Vector3(const Vector3& vector) (GC)
  6464. - Vector3* new(const Vector3& vector)
  6465. - Vector3(const Vector2& vector, float z) (GC)
  6466. - Vector3* new(const Vector2& vector, float z)
  6467. - Vector3(const Vector2& vector) (GC)
  6468. - Vector3* new(const Vector2& vector)
  6469. - Vector3(const IntVector3& vector) (GC)
  6470. - Vector3* new(const IntVector3& vector)
  6471. - Vector3(float x, float y, float z) (GC)
  6472. - Vector3* new(float x, float y, float z)
  6473. - Vector3(float x, float y) (GC)
  6474. - Vector3* new(float x, float y)
  6475. - void delete()
  6476. - bool operator==(const Vector3& rhs) const
  6477. - Vector3 operator+(const Vector3& rhs) const
  6478. - Vector3 operator-() const
  6479. - Vector3 operator-(const Vector3& rhs) const
  6480. - Vector3 operator*(float rhs) const
  6481. - Vector3 operator*(const Vector3& rhs) const
  6482. - Vector3 operator/(float rhs) const
  6483. - Vector3 operator/(const Vector3& rhs) const
  6484. - void Normalize()
  6485. - float Length() const
  6486. - float LengthSquared() const
  6487. - float DotProduct(const Vector3& rhs) const
  6488. - float AbsDotProduct(const Vector3& rhs) const
  6489. - float ProjectOntoAxis(const Vector3& axis) const
  6490. - Vector3 CrossProduct(const Vector3& rhs) const
  6491. - Vector3 Abs() const
  6492. - Vector3 Lerp(const Vector3& rhs, float t) const
  6493. - bool Equals(const Vector3& rhs) const
  6494. - bool IsNaN() const
  6495. - float Angle(const Vector3& rhs) const
  6496. - Vector3 Normalized() const
  6497. - String ToString() const
  6498. Properties:
  6499. - float x
  6500. - float y
  6501. - float z
  6502. - const Vector3 ZERO
  6503. - const Vector3 LEFT
  6504. - const Vector3 RIGHT
  6505. - const Vector3 UP
  6506. - const Vector3 DOWN
  6507. - const Vector3 FORWARD
  6508. - const Vector3 BACK
  6509. - const Vector3 ONE
  6510. <a name="Class_Vector4"></a>
  6511. ### Vector4
  6512. Methods:
  6513. - Vector4() (GC)
  6514. - Vector4* new()
  6515. - Vector4(const Vector4& vector) (GC)
  6516. - Vector4* new(const Vector4& vector)
  6517. - Vector4(const Vector3& vector, float w) (GC)
  6518. - Vector4* new(const Vector3& vector, float w)
  6519. - Vector4(float x, float y, float z, float w) (GC)
  6520. - Vector4* new(float x, float y, float z, float w)
  6521. - void delete()
  6522. - bool operator==(const Vector4& rhs) const
  6523. - Vector4 operator+(const Vector4& rhs) const
  6524. - Vector4 operator-() const
  6525. - Vector4 operator-(const Vector4& rhs) const
  6526. - Vector4 operator*(float rhs) const
  6527. - Vector4 operator*(const Vector4& rhs) const
  6528. - Vector4 operator/(float rhs) const
  6529. - Vector4 operator/(const Vector4& rhs) const
  6530. - Vector4 operator/(const Vector4& rhs) const
  6531. - float DotProduct(const Vector4& rhs) const
  6532. - float AbsDotProduct(const Vector4& rhs) const
  6533. - float ProjectOntoAxis(const Vector3& axis) const
  6534. - Vector4 Abs() const
  6535. - Vector4 Lerp(const Vector4& rhs, float t) const
  6536. - bool Equals(const Vector4& rhs) const
  6537. - bool IsNaN() const
  6538. - String ToString() const
  6539. Properties:
  6540. - float x
  6541. - float y
  6542. - float z
  6543. - float w
  6544. - const Vector4 ZERO
  6545. - const Vector4 ONE
  6546. <a name="Class_VectorBuffer"></a>
  6547. ### VectorBuffer
  6548. Methods:
  6549. - VectorBuffer() (GC)
  6550. - VectorBuffer* new()
  6551. - VectorBuffer(Deserializer& source, unsigned size) (GC)
  6552. - VectorBuffer* new(Deserializer& source, unsigned size)
  6553. - void delete()
  6554. - void SetData(Deserializer& source, unsigned size)
  6555. - void Clear()
  6556. - void Resize(unsigned size)
  6557. - const void* GetData() const
  6558. - void* GetModifiableData()
  6559. - VectorBuffer Read(unsigned size)
  6560. - unsigned Seek(unsigned position)
  6561. - const String GetName() const
  6562. - unsigned GetChecksum()
  6563. - unsigned GetPosition() const
  6564. - unsigned GetSize() const
  6565. - bool IsEof() const
  6566. - int ReadInt()
  6567. - long ReadInt64()
  6568. - short ReadShort()
  6569. - char ReadByte()
  6570. - unsigned ReadUInt()
  6571. - long ReadUInt64()
  6572. - short ReadUShort()
  6573. - char ReadUByte()
  6574. - bool ReadBool()
  6575. - float ReadFloat()
  6576. - double ReadDouble()
  6577. - IntRect ReadIntRect()
  6578. - IntVector2 ReadIntVector2()
  6579. - IntVector3 ReadIntVector3()
  6580. - Rect ReadRect()
  6581. - Vector2 ReadVector2()
  6582. - Vector3 ReadVector3()
  6583. - Vector3 ReadPackedVector3(float maxAbsCoord)
  6584. - Vector4 ReadVector4()
  6585. - Quaternion ReadQuaternion()
  6586. - Quaternion ReadPackedQuaternion()
  6587. - Matrix3 ReadMatrix3()
  6588. - Matrix3x4 ReadMatrix3x4()
  6589. - Matrix4 ReadMatrix4()
  6590. - Color ReadColor()
  6591. - BoundingBox ReadBoundingBox()
  6592. - String ReadString()
  6593. - String ReadFileID()
  6594. - StringHash ReadStringHash()
  6595. - VectorBuffer ReadBuffer()
  6596. - ResourceRef ReadResourceRef()
  6597. - ResourceRefList ReadResourceRefList()
  6598. - Variant ReadVariant()
  6599. - Variant ReadVariant(VariantType type)
  6600. - VariantVector ReadVariantVector()
  6601. - VariantMap ReadVariantMap()
  6602. - unsigned ReadVLE()
  6603. - unsigned ReadNetID()
  6604. - String ReadLine()
  6605. - unsigned Write(const VectorBuffer& buffer)
  6606. - bool WriteInt(int value)
  6607. - bool WriteInt64(long value)
  6608. - bool WriteShort(short value)
  6609. - bool WriteByte(char value)
  6610. - bool WriteUInt(unsigned value)
  6611. - bool WriteUInt64(long value)
  6612. - bool WriteUShort(short value)
  6613. - bool WriteUByte(char value)
  6614. - bool WriteBool(bool value)
  6615. - bool WriteFloat(float value)
  6616. - bool WriteDouble(double value)
  6617. - bool WriteIntRect(const IntRect& value)
  6618. - bool WriteIntVector2(const IntVector2& value)
  6619. - bool WriteIntVector3(const IntVector3& value)
  6620. - bool WriteRect(const Rect& value)
  6621. - bool WriteVector2(const Vector2& value)
  6622. - bool WriteVector3(const Vector3& value)
  6623. - bool WritePackedVector3(const Vector3& value, float maxAbsCoord)
  6624. - bool WriteVector4(const Vector4& value)
  6625. - bool WriteQuaternion(const Quaternion& value)
  6626. - bool WritePackedQuaternion(const Quaternion& value)
  6627. - bool WriteMatrix3(const Matrix3& value)
  6628. - bool WriteMatrix3x4(const Matrix3x4& value)
  6629. - bool WriteMatrix4(const Matrix4& value)
  6630. - bool WriteColor(const Color& value)
  6631. - bool WriteBoundingBox(const BoundingBox& value)
  6632. - bool WriteString(const String value)
  6633. - bool WriteFileID(const String value)
  6634. - bool WriteStringHash(const StringHash& value)
  6635. - bool WriteBuffer(const VectorBuffer& buffer)
  6636. - bool WriteResourceRef(const ResourceRef& value)
  6637. - bool WriteResourceRefList(const ResourceRefList& value)
  6638. - bool WriteVariant(const Variant& value)
  6639. - bool WriteVariantData(const Variant& value)
  6640. - bool WriteVariantVector(const VariantVector& value)
  6641. - bool WriteVariantMap(const VariantMap& value)
  6642. - bool WriteVLE(unsigned value)
  6643. - bool WriteNetID(unsigned value)
  6644. - bool WriteLine(const String value)
  6645. Properties:
  6646. - String name (readonly)
  6647. - unsigned checksum (readonly)
  6648. - unsigned position (readonly)
  6649. - unsigned size (readonly)
  6650. - bool eof (readonly)
  6651. <a name="Class_VertexBuffer"></a>
  6652. ### VertexBuffer : Object
  6653. Methods:
  6654. - VertexBuffer() (GC)
  6655. - VertexBuffer* new()
  6656. - void delete()
  6657. - void SetShadowed(bool enable)
  6658. - bool SetSize(unsigned vertexCount, const PODVector<VertexElement>& elements, bool dynamic = false)
  6659. - bool SetSize(unsigned vertexCount, unsigned elementMask, bool dynamic = false)
  6660. - bool SetData(VectorBuffer& data)
  6661. - bool SetDataRange(VectorBuffer& data, unsigned start, unsigned count, bool discard = false)
  6662. - VectorBuffer GetData()
  6663. - bool IsShadowed() const
  6664. - bool IsDynamic() const
  6665. - unsigned GetVertexCount() const
  6666. - unsigned GetVertexSize() const
  6667. - const PODVector<VertexElement>& GetElements() const
  6668. - bool HasElement(VertexElementSemantic semantic, char index = 0) const
  6669. - bool HasElement(VertexElementType type, VertexElementSemantic semantic, char index = 0) const
  6670. - unsigned GetElementOffset(VertexElementSemantic semantic, char index = 0) const
  6671. - unsigned GetElementOffset(VertexElementType type, VertexElementSemantic semantic, char index = 0) const
  6672. - unsigned GetElementMask() const
  6673. Properties:
  6674. - bool shadowed
  6675. - bool dynamic (readonly)
  6676. - unsigned vertexCount (readonly)
  6677. - unsigned vertexSize (readonly)
  6678. - unsigned elementMask (readonly)
  6679. <a name="Class_VertexElement"></a>
  6680. ### VertexElement
  6681. Methods:
  6682. - VertexElement() (GC)
  6683. - VertexElement* new()
  6684. - VertexElement(VertexElementType type, VertexElementSemantic semantic, char index = 0, bool perInstance = false) (GC)
  6685. - VertexElement* new(VertexElementType type, VertexElementSemantic semantic, char index = 0, bool perInstance = false)
  6686. Properties:
  6687. - VertexElementType type
  6688. - VertexElementSemantic semantic
  6689. - char index
  6690. - bool perInstance
  6691. - unsigned offset
  6692. <a name="Class_View3D"></a>
  6693. ### View3D : Window
  6694. Methods:
  6695. - View3D() (GC)
  6696. - View3D* new()
  6697. - void delete()
  6698. - void SetView(Scene* scene, Camera* camera, bool ownScene = true)
  6699. - void SetFormat(unsigned format)
  6700. - void SetAutoUpdate(bool enable)
  6701. - void QueueUpdate()
  6702. - unsigned GetFormat() const
  6703. - bool GetAutoUpdate() const
  6704. - Scene* GetScene() const
  6705. - Node* GetCameraNode() const
  6706. - Texture2D* GetRenderTexture() const
  6707. - Texture2D* GetDepthTexture() const
  6708. - Viewport* GetViewport() const
  6709. Properties:
  6710. - unsigned format
  6711. - bool autoUpdate
  6712. <a name="Class_Viewport"></a>
  6713. ### Viewport
  6714. Methods:
  6715. - Viewport() (GC)
  6716. - Viewport* new()
  6717. - Viewport(Scene* scene, Camera* camera, RenderPath* renderPath = 0) (GC)
  6718. - Viewport* new(Scene* scene, Camera* camera, RenderPath* renderPath = 0)
  6719. - Viewport(Scene* scene, Camera* camera, const IntRect& rect, RenderPath* renderPath = 0) (GC)
  6720. - Viewport* new(Scene* scene, Camera* camera, const IntRect& rect, RenderPath* renderPath = 0)
  6721. - void delete()
  6722. - void SetScene(Scene* scene)
  6723. - void SetCamera(Camera* camera)
  6724. - void SetCullCamera(Camera* camera)
  6725. - void SetRect(const IntRect& rect)
  6726. - void SetRenderPath(RenderPath* path)
  6727. - void SetRenderPath(XMLFile* file)
  6728. - void SetDrawDebug(bool enable)
  6729. - Scene* GetScene() const
  6730. - Camera* GetCamera() const
  6731. - Camera* GetCullCamera() const
  6732. - const IntRect& GetRect() const
  6733. - RenderPath* GetRenderPath() const
  6734. - bool GetDrawDebug() const
  6735. - Ray GetScreenRay(int x, int y) const
  6736. - IntVector2 WorldToScreenPoint(const Vector3& worldPos) const
  6737. - Vector3 ScreenToWorldPoint(int x, int y, float depth) const
  6738. Properties:
  6739. - Scene* scene
  6740. - Camera* camera
  6741. - Camera* cullCamera
  6742. - IntRect& rect
  6743. - RenderPath* renderPath
  6744. - bool drawDebug
  6745. <a name="Class_Window"></a>
  6746. ### Window : BorderImage
  6747. Methods:
  6748. - Window() (GC)
  6749. - Window* new()
  6750. - void delete()
  6751. - void SetMovable(bool enable)
  6752. - void SetResizable(bool enable)
  6753. - void SetFixedWidthResizing(bool enable)
  6754. - void SetFixedHeightResizing(bool enable)
  6755. - void SetResizeBorder(const IntRect& rect)
  6756. - void SetModal(bool modal)
  6757. - void SetModalShadeColor(const Color& color)
  6758. - void SetModalFrameColor(const Color& color)
  6759. - void SetModalFrameSize(const IntVector2& size)
  6760. - void SetModalAutoDismiss(bool enable)
  6761. - bool IsMovable() const
  6762. - bool IsResizable() const
  6763. - bool GetFixedWidthResizing() const
  6764. - bool GetFixedHeightResizing() const
  6765. - const IntRect& GetResizeBorder() const
  6766. - bool IsModal() const
  6767. - const Color& GetModalShadeColor() const
  6768. - const Color& GetModalFrameColor() const
  6769. - const IntVector2& GetModalFrameSize() const
  6770. - bool GetModalAutoDismiss() const
  6771. Properties:
  6772. - bool movable
  6773. - bool resizable
  6774. - bool fixedWidthResizing
  6775. - bool fixedHeightResizing
  6776. - IntRect& resizeBorder
  6777. - bool modal
  6778. - Color& modalShadeColor
  6779. - Color& modalFrameColor
  6780. - IntVector2& modalFrameSize
  6781. - bool modalAutoDismiss
  6782. <a name="Class_XMLElement"></a>
  6783. ### XMLElement
  6784. Methods:
  6785. - XMLElement CreateChild(const String name)
  6786. - XMLElement GetOrCreateChild(const String name)
  6787. - bool RemoveChild(const XMLElement& element)
  6788. - bool RemoveChild(const String name)
  6789. - bool RemoveChildren(const String name = String::EMPTY)
  6790. - bool RemoveAttribute(const String name = String::EMPTY)
  6791. - bool SetValue(const String value)
  6792. - bool SetAttribute(const String name, const String value)
  6793. - bool SetAttribute(const String value)
  6794. - bool SetBool(const String name, bool value)
  6795. - bool SetBoundingBox(const BoundingBox& value)
  6796. - bool SetColor(const String name, const Color& value)
  6797. - bool SetFloat(const String name, float value)
  6798. - bool SetDouble(const String name, double value)
  6799. - bool SetUInt(const String name, unsigned value)
  6800. - bool SetInt(const String name, int value)
  6801. - bool SetUInt64(const String name, long value)
  6802. - bool SetInt64(const String name, long value)
  6803. - bool SetIntRect(const String name, const IntRect& value)
  6804. - bool SetIntVector2(const String name, const IntVector2& value)
  6805. - bool SetIntVector3(const String name, const IntVector3& value)
  6806. - bool SetRect(const String name, const Rect& value)
  6807. - bool SetQuaternion(const String name, const Quaternion& value)
  6808. - bool SetString(const String name, const String value)
  6809. - bool SetVariant(const Variant& value)
  6810. - bool SetVariantValue(const Variant& value)
  6811. - bool SetResourceRef(const ResourceRef& value)
  6812. - bool SetResourceRefList(const ResourceRefList& value)
  6813. - bool SetVector2(const String name, const Vector2& value)
  6814. - bool SetVector3(const String name, const Vector3& value)
  6815. - bool SetVector4(const String name, const Vector4& value)
  6816. - bool SetVectorVariant(const String name, const Variant& value)
  6817. - bool SetMatrix3(const String name, const Matrix3& value)
  6818. - bool SetMatrix3x4(const String name, const Matrix3x4& value)
  6819. - bool SetMatrix4(const String name, const Matrix4& value)
  6820. - bool IsNull() const
  6821. - bool NotNull() const
  6822. - bool operatorbool() const
  6823. - String GetName() const
  6824. - bool HasChild(const String name) const
  6825. - XMLElement GetChild(const String name = String::EMPTY) const
  6826. - XMLElement GetNext(const String name = String::EMPTY) const
  6827. - XMLElement GetParent() const
  6828. - unsigned GetNumAttributes() const
  6829. - bool HasAttribute(const String name) const
  6830. - String GetValue() const
  6831. - String GetAttribute(const String name = String::EMPTY) const
  6832. - String GetAttributeLower(const String name) const
  6833. - String GetAttributeUpper(const String name) const
  6834. - Vector<String> GetAttributeNames() const
  6835. - bool GetBool(const String name) const
  6836. - BoundingBox GetBoundingBox() const
  6837. - Color GetColor(const String name) const
  6838. - float GetFloat(const String name) const
  6839. - double GetDouble(const String name) const
  6840. - unsigned GetUInt(const String name) const
  6841. - int GetInt(const String name) const
  6842. - long GetUInt64(const String name) const
  6843. - long GetInt64(const String name) const
  6844. - IntRect GetIntRect(const String name) const
  6845. - IntVector2 GetIntVector2(const String name) const
  6846. - IntVector3 GetIntVector3(const String name) const
  6847. - Rect GetRect(const String name) const
  6848. - Quaternion GetQuaternion(const String name) const
  6849. - Variant GetVariant() const
  6850. - Variant GetVariantValue(VariantType type) const
  6851. - ResourceRef GetResourceRef() const
  6852. - ResourceRefList GetResourceRefList() const
  6853. - VariantMap GetVariantMap() const
  6854. - Vector2 GetVector2(const String name) const
  6855. - Vector3 GetVector3(const String name) const
  6856. - Vector4 GetVector4(const String name) const
  6857. - Vector4 GetVector(const String name) const
  6858. - Matrix3 GetMatrix3(const String name) const
  6859. - Matrix3x4 GetMatrix3x4(const String name) const
  6860. - Matrix4 GetMatrix4(const String name) const
  6861. - XMLFile* GetFile() const
  6862. Properties:
  6863. - const XMLElement EMPTY
  6864. - bool null (readonly)
  6865. - String name (readonly)
  6866. - XMLElement parent (readonly)
  6867. - String value (readonly)
  6868. - unsigned numAttributes (readonly)
  6869. - XMLFile* file (readonly)
  6870. <a name="Class_XMLFile"></a>
  6871. ### XMLFile : Resource
  6872. Methods:
  6873. - XMLFile() (GC)
  6874. - XMLFile* new()
  6875. - void delete()
  6876. - bool FromString(const String source)
  6877. - XMLElement CreateRoot(const String name = String::EMPTY)
  6878. - XMLElement GetOrCreateRoot(const String name = String::EMPTY)
  6879. - XMLElement GetRoot(const String name = String::EMPTY)
  6880. - String ToString(const String indentation = "\t") const
  6881. - void Patch(XMLFile* patchFile)
  6882. - void Patch(XMLElement patchElement)
  6883. - bool Save(const String fileName, const String indentation = "\t") const
  6884. <a name="Class_Zone"></a>
  6885. ### Zone : Drawable
  6886. Methods:
  6887. - void SetBoundingBox(const BoundingBox& box)
  6888. - void SetAmbientColor(const Color& color)
  6889. - void SetFogColor(const Color& color)
  6890. - void SetFogStart(float start)
  6891. - void SetFogEnd(float end)
  6892. - void SetFogHeight(float height)
  6893. - void SetFogHeightScale(float scale)
  6894. - void SetPriority(int priority)
  6895. - void SetHeightFog(bool enable)
  6896. - void SetOverride(bool enable)
  6897. - void SetAmbientGradient(bool enable)
  6898. - void SetZoneTexture(Texture* texture)
  6899. - const Matrix3x4& GetInverseWorldTransform() const
  6900. - const Color& GetAmbientColor() const
  6901. - const Color& GetAmbientStartColor()
  6902. - const Color& GetAmbientEndColor()
  6903. - const Color& GetFogColor() const
  6904. - float GetFogStart() const
  6905. - float GetFogEnd() const
  6906. - float GetFogHeight() const
  6907. - float GetFogHeightScale() const
  6908. - int GetPriority() const
  6909. - bool GetHeightFog() const
  6910. - bool GetOverride() const
  6911. - bool GetAmbientGradient() const
  6912. - Texture* GetZoneTexture() const
  6913. - bool IsInside(const Vector3& point) const
  6914. Properties:
  6915. - BoundingBox& boundingBox
  6916. - Matrix3x4& inverseWorldTransform (readonly)
  6917. - Color& ambientColor
  6918. - Color& ambientStartColor (readonly)
  6919. - Color& ambientEndColor (readonly)
  6920. - Color& fogColor
  6921. - float fogStart
  6922. - float fogEnd
  6923. - float fogHeight
  6924. - float fogHeightScale
  6925. - int priority
  6926. - bool heightFog
  6927. - bool override
  6928. - bool ambientGradient
  6929. - Texture* zoneTexture
  6930. \section LuaScriptAPI_Enums Enumerations
  6931. ### Algorithm
  6932. - int FABRIK
  6933. ### AnimationBlendMode
  6934. - int ABM_LERP
  6935. - int ABM_ADDITIVE
  6936. ### AutoRemoveMode
  6937. - int REMOVE_DISABLED
  6938. - int REMOVE_COMPONENT
  6939. - int REMOVE_NODE
  6940. ### BlendMode
  6941. - int BLEND_REPLACE
  6942. - int BLEND_ADD
  6943. - int BLEND_MULTIPLY
  6944. - int BLEND_ALPHA
  6945. - int BLEND_ADDALPHA
  6946. - int BLEND_PREMULALPHA
  6947. - int BLEND_INVDESTALPHA
  6948. - int BLEND_SUBTRACT
  6949. - int BLEND_SUBTRACTALPHA
  6950. - int MAX_BLENDMODES
  6951. ### BodyType2D
  6952. - int BT_STATIC
  6953. - int BT_KINEMATIC
  6954. - int BT_DYNAMIC
  6955. ### CollisionEventMode
  6956. - int COLLISION_NEVER
  6957. - int COLLISION_ACTIVE
  6958. - int COLLISION_ALWAYS
  6959. ### CompareMode
  6960. - int CMP_ALWAYS
  6961. - int CMP_EQUAL
  6962. - int CMP_NOTEQUAL
  6963. - int CMP_LESS
  6964. - int CMP_LESSEQUAL
  6965. - int CMP_GREATER
  6966. - int CMP_GREATEREQUAL
  6967. - int MAX_COMPAREMODES
  6968. ### CompressedFormat
  6969. - int CF_NONE
  6970. - int CF_RGBA
  6971. - int CF_DXT1
  6972. - int CF_DXT3
  6973. - int CF_DXT5
  6974. - int CF_ETC1
  6975. - int CF_PVRTC_RGB_2BPP
  6976. - int CF_PVRTC_RGBA_2BPP
  6977. - int CF_PVRTC_RGB_4BPP
  6978. - int CF_PVRTC_RGBA_4BPP
  6979. ### ConstraintType
  6980. - int CONSTRAINT_POINT
  6981. - int CONSTRAINT_HINGE
  6982. - int CONSTRAINT_SLIDER
  6983. - int CONSTRAINT_CONETWIST
  6984. ### Corner
  6985. - int C_TOPLEFT
  6986. - int C_TOPRIGHT
  6987. - int C_BOTTOMLEFT
  6988. - int C_BOTTOMRIGHT
  6989. - int MAX_UIELEMENT_CORNERS
  6990. ### CreateMode
  6991. - int REPLICATED
  6992. - int LOCAL
  6993. ### CrowdAgentRequestedTarget
  6994. - int CA_REQUESTEDTARGET_NONE
  6995. - int CA_REQUESTEDTARGET_POSITION
  6996. - int CA_REQUESTEDTARGET_VELOCITY
  6997. ### CrowdAgentState
  6998. - int CA_STATE_INVALID
  6999. - int CA_STATE_WALKING
  7000. - int CA_STATE_OFFMESH
  7001. ### CrowdAgentTargetState
  7002. - int CA_TARGET_NONE
  7003. - int CA_TARGET_FAILED
  7004. - int CA_TARGET_VALID
  7005. - int CA_TARGET_REQUESTING
  7006. - int CA_TARGET_WAITINGFORQUEUE
  7007. - int CA_TARGET_WAITINGFORPATH
  7008. - int CA_TARGET_VELOCITY
  7009. ### CubeMapFace
  7010. - int FACE_POSITIVE_X
  7011. - int FACE_NEGATIVE_X
  7012. - int FACE_POSITIVE_Y
  7013. - int FACE_NEGATIVE_Y
  7014. - int FACE_POSITIVE_Z
  7015. - int FACE_NEGATIVE_Z
  7016. - int MAX_CUBEMAP_FACES
  7017. ### CullMode
  7018. - int CULL_NONE
  7019. - int CULL_CCW
  7020. - int CULL_CW
  7021. - int MAX_CULLMODES
  7022. ### CursorShape
  7023. - int CS_NORMAL
  7024. - int CS_IBEAM
  7025. - int CS_CROSS
  7026. - int CS_RESIZEVERTICAL
  7027. - int CS_RESIZEDIAGONAL_TOPRIGHT
  7028. - int CS_RESIZEHORIZONTAL
  7029. - int CS_RESIZEDIAGONAL_TOPLEFT
  7030. - int CS_RESIZE_ALL
  7031. - int CS_ACCEPTDROP
  7032. - int CS_REJECTDROP
  7033. - int CS_BUSY
  7034. - int CS_BUSY_ARROW
  7035. - int CS_MAX_SHAPES
  7036. ### DBAPI
  7037. - int DBAPI_SQLITE
  7038. - int DBAPI_ODBC
  7039. ### EmitterType
  7040. - int EMITTER_SPHERE
  7041. - int EMITTER_BOX
  7042. ### EmitterType2D
  7043. - int EMITTER_TYPE_GRAVITY
  7044. - int EMITTER_TYPE_RADIAL
  7045. ### FaceCameraMode
  7046. - int FC_NONE
  7047. - int FC_ROTATE_XYZ
  7048. - int FC_ROTATE_Y
  7049. - int FC_LOOKAT_XYZ
  7050. - int FC_LOOKAT_Y
  7051. - int FC_LOOKAT_MIXED
  7052. - int FC_DIRECTION
  7053. ### FaceCameraMode
  7054. - int FC_NONE
  7055. - int FC_ROTATE_XYZ
  7056. - int FC_ROTATE_Y
  7057. - int FC_LOOKAT_XYZ
  7058. - int FC_LOOKAT_Y
  7059. - int FC_LOOKAT_MIXED
  7060. - int FC_DIRECTION
  7061. ### FileMode
  7062. - int FILE_READ
  7063. - int FILE_WRITE
  7064. - int FILE_READWRITE
  7065. ### FillMode
  7066. - int FILL_SOLID
  7067. - int FILL_WIREFRAME
  7068. - int FILL_POINT
  7069. ### FocusMode
  7070. - int FM_NOTFOCUSABLE
  7071. - int FM_RESETFOCUS
  7072. - int FM_FOCUSABLE
  7073. - int FM_FOCUSABLE_DEFOCUSABLE
  7074. ### FontType
  7075. - int FONT_NONE
  7076. - int FONT_FREETYPE
  7077. - int FONT_BITMAP
  7078. - int MAX_FONT_TYPES
  7079. ### FrustumPlane
  7080. - int PLANE_NEAR
  7081. - int PLANE_LEFT
  7082. - int PLANE_RIGHT
  7083. - int PLANE_UP
  7084. - int PLANE_DOWN
  7085. - int PLANE_FAR
  7086. ### GeometryType
  7087. - int GEOM_STATIC
  7088. - int GEOM_SKINNED
  7089. - int GEOM_INSTANCED
  7090. - int GEOM_BILLBOARD
  7091. - int GEOM_STATIC_NOINSTANCING
  7092. - int MAX_GEOMETRYTYPES
  7093. ### HighlightMode
  7094. - int HM_NEVER
  7095. - int HM_FOCUS
  7096. - int HM_ALWAYS
  7097. ### HorizontalAlignment
  7098. - int HA_LEFT
  7099. - int HA_CENTER
  7100. - int HA_RIGHT
  7101. - int HA_CUSTOM
  7102. ### HttpRequestState
  7103. - int HTTP_INITIALIZING
  7104. - int HTTP_ERROR
  7105. - int HTTP_OPEN
  7106. - int HTTP_CLOSED
  7107. ### InterpMethod
  7108. - int IM_NONE
  7109. - int IM_LINEAR
  7110. - int IM_SPLINE
  7111. ### InterpolationMode
  7112. - int BEZIER_CURVE
  7113. - int CATMULL_ROM_CURVE
  7114. - int LINEAR_CURVE
  7115. - int CATMULL_ROM_FULL_CURVE
  7116. ### Intersection
  7117. - int OUTSIDE
  7118. - int INTERSECTS
  7119. - int INSIDE
  7120. ### JSONNumberType
  7121. - int JSONNT_NAN
  7122. - int JSONNT_INT
  7123. - int JSONNT_UINT
  7124. - int JSONNT_FLOAT_DOUBLE
  7125. ### JSONValueType
  7126. - int JSON_NULL
  7127. - int JSON_BOOL
  7128. - int JSON_NUMBER
  7129. - int JSON_STRING
  7130. - int JSON_ARRAY
  7131. - int JSON_OBJECT
  7132. ### LayoutMode
  7133. - int LM_FREE
  7134. - int LM_HORIZONTAL
  7135. - int LM_VERTICAL
  7136. ### LegacyVertexElement
  7137. - int ELEMENT_POSITION
  7138. - int ELEMENT_NORMAL
  7139. - int ELEMENT_COLOR
  7140. - int ELEMENT_TEXCOORD1
  7141. - int ELEMENT_TEXCOORD2
  7142. - int ELEMENT_CUBETEXCOORD1
  7143. - int ELEMENT_CUBETEXCOORD2
  7144. - int ELEMENT_TANGENT
  7145. - int ELEMENT_BLENDWEIGHTS
  7146. - int ELEMENT_BLENDINDICES
  7147. - int ELEMENT_INSTANCEMATRIX1
  7148. - int ELEMENT_INSTANCEMATRIX2
  7149. - int ELEMENT_INSTANCEMATRIX3
  7150. - int ELEMENT_OBJECTINDEX
  7151. - int MAX_LEGACY_VERTEX_ELEMENTS
  7152. ### LightType
  7153. - int LIGHT_DIRECTIONAL
  7154. - int LIGHT_SPOT
  7155. - int LIGHT_POINT
  7156. ### LoadMode
  7157. - int LOAD_RESOURCES_ONLY
  7158. - int LOAD_SCENE
  7159. - int LOAD_SCENE_AND_RESOURCES
  7160. ### LockState
  7161. - int LOCK_NONE
  7162. - int LOCK_HARDWARE
  7163. - int LOCK_SHADOW
  7164. - int LOCK_SCRATCH
  7165. ### LoopMode2D
  7166. - int LM_DEFAULT
  7167. - int LM_FORCE_LOOPED
  7168. - int LM_FORCE_CLAMPED
  7169. ### MouseMode
  7170. - int MM_ABSOLUTE
  7171. - int MM_RELATIVE
  7172. - int MM_WRAP
  7173. - int MM_FREE
  7174. ### NavigationPushiness
  7175. - int NAVIGATIONPUSHINESS_LOW
  7176. - int NAVIGATIONPUSHINESS_MEDIUM
  7177. - int NAVIGATIONPUSHINESS_HIGH
  7178. - int NAVIGATIONPUSHINESS_NONE
  7179. ### NavigationQuality
  7180. - int NAVIGATIONQUALITY_LOW
  7181. - int NAVIGATIONQUALITY_MEDIUM
  7182. - int NAVIGATIONQUALITY_HIGH
  7183. ### NavmeshPartitionType
  7184. - int NAVMESH_PARTITION_WATERSHED
  7185. - int NAVMESH_PARTITION_MONOTONE
  7186. ### Orientation
  7187. - int O_HORIZONTAL
  7188. - int O_VERTICAL
  7189. ### Orientation2D
  7190. - int O_ORTHOGONAL
  7191. - int O_ISOMETRIC
  7192. - int O_STAGGERED
  7193. - int O_HEXAGONAL
  7194. ### PassLightingMode
  7195. - int LIGHTING_UNLIT
  7196. - int LIGHTING_PERVERTEX
  7197. - int LIGHTING_PERPIXEL
  7198. ### PrimitiveType
  7199. - int TRIANGLE_LIST
  7200. - int LINE_LIST
  7201. - int POINT_LIST
  7202. - int TRIANGLE_STRIP
  7203. - int LINE_STRIP
  7204. - int TRIANGLE_FAN
  7205. ### RayQueryLevel
  7206. - int RAY_AABB
  7207. - int RAY_OBB
  7208. - int RAY_TRIANGLE
  7209. - int RAY_TRIANGLE_UV
  7210. ### RenderCommandSortMode
  7211. - int SORT_FRONTTOBACK
  7212. - int SORT_BACKTOFRONT
  7213. ### RenderCommandType
  7214. - int CMD_NONE
  7215. - int CMD_CLEAR
  7216. - int CMD_SCENEPASS
  7217. - int CMD_QUAD
  7218. - int CMD_FORWARDLIGHTS
  7219. - int CMD_LIGHTVOLUMES
  7220. - int CMD_RENDERUI
  7221. - int CMD_SENDEVENT
  7222. ### RenderSurfaceUpdateMode
  7223. - int SURFACE_MANUALUPDATE
  7224. - int SURFACE_UPDATEVISIBLE
  7225. - int SURFACE_UPDATEALWAYS
  7226. ### RenderTargetSizeMode
  7227. - int SIZE_ABSOLUTE
  7228. - int SIZE_VIEWPORTDIVISOR
  7229. - int SIZE_VIEWPORTMULTIPLIER
  7230. ### ShaderType
  7231. - int VS
  7232. - int PS
  7233. ### ShadowQuality
  7234. - int SHADOWQUALITY_SIMPLE_16BIT
  7235. - int SHADOWQUALITY_SIMPLE_24BIT
  7236. - int SHADOWQUALITY_PCF_16BIT
  7237. - int SHADOWQUALITY_PCF_24BIT
  7238. - int SHADOWQUALITY_VSM
  7239. - int SHADOWQUALITY_BLUR_VSM
  7240. ### ShapeType
  7241. - int SHAPE_BOX
  7242. - int SHAPE_SPHERE
  7243. - int SHAPE_STATICPLANE
  7244. - int SHAPE_CYLINDER
  7245. - int SHAPE_CAPSULE
  7246. - int SHAPE_CONE
  7247. - int SHAPE_TRIANGLEMESH
  7248. - int SHAPE_CONVEXHULL
  7249. - int SHAPE_TERRAIN
  7250. ### StencilOp
  7251. - int OP_KEEP
  7252. - int OP_ZERO
  7253. - int OP_REF
  7254. - int OP_INCR
  7255. - int OP_DECR
  7256. ### TextEffect
  7257. - int TE_NONE
  7258. - int TE_SHADOW
  7259. - int TE_STROKE
  7260. ### TextureAddressMode
  7261. - int ADDRESS_WRAP
  7262. - int ADDRESS_MIRROR
  7263. - int ADDRESS_CLAMP
  7264. - int ADDRESS_BORDER
  7265. - int MAX_ADDRESSMODES
  7266. ### TextureCoordinate
  7267. - int COORD_U
  7268. - int COORD_V
  7269. - int COORD_W
  7270. - int MAX_COORDS
  7271. ### TextureFilterMode
  7272. - int FILTER_NEAREST
  7273. - int FILTER_BILINEAR
  7274. - int FILTER_TRILINEAR
  7275. - int FILTER_ANISOTROPIC
  7276. - int FILTER_NEAREST_ANISOTROPIC
  7277. - int FILTER_DEFAULT
  7278. - int MAX_FILTERMODES
  7279. ### TextureUnit
  7280. - int TU_DIFFUSE
  7281. - int TU_ALBEDOBUFFER
  7282. - int TU_NORMAL
  7283. - int TU_NORMALBUFFER
  7284. - int TU_SPECULAR
  7285. - int TU_EMISSIVE
  7286. - int TU_ENVIRONMENT
  7287. ### TextureUsage
  7288. - int TEXTURE_STATIC
  7289. - int TEXTURE_DYNAMIC
  7290. - int TEXTURE_RENDERTARGET
  7291. - int TEXTURE_DEPTHSTENCIL
  7292. ### TileMapLayerType2D
  7293. - int LT_TILE_LAYER
  7294. - int LT_OBJECT_GROUP
  7295. - int LT_IMAGE_LAYER
  7296. - int LT_INVALID
  7297. ### TileMapObjectType2D
  7298. - int OT_RECTANGLE
  7299. - int OT_ELLIPSE
  7300. - int OT_POLYGON
  7301. - int OT_POLYLINE
  7302. - int OT_TILE
  7303. - int OT_INVALID
  7304. ### TrailType
  7305. - int TT_FACE_CAMERA
  7306. - int TT_BONE
  7307. ### TransformSpace
  7308. - int TS_LOCAL
  7309. - int TS_PARENT
  7310. - int TS_WORLD
  7311. ### TraversalMode
  7312. - int TM_BREADTH_FIRST
  7313. - int TM_DEPTH_FIRST
  7314. ### VariantType
  7315. - int VAR_NONE
  7316. - int VAR_INT
  7317. - int VAR_BOOL
  7318. - int VAR_FLOAT
  7319. - int VAR_VECTOR2
  7320. - int VAR_VECTOR3
  7321. - int VAR_VECTOR4
  7322. - int VAR_QUATERNION
  7323. - int VAR_COLOR
  7324. - int VAR_STRING
  7325. - int VAR_BUFFER
  7326. - int VAR_VOIDPTR
  7327. - int VAR_RESOURCEREF
  7328. - int VAR_RESOURCEREFLIST
  7329. - int VAR_VARIANTVECTOR
  7330. - int VAR_VARIANTMAP
  7331. - int VAR_INTRECT
  7332. - int VAR_INTVECTOR2
  7333. - int VAR_PTR
  7334. - int VAR_MATRIX3
  7335. - int VAR_MATRIX3X4
  7336. - int VAR_MATRIX4
  7337. - int VAR_DOUBLE
  7338. - int VAR_STRINGVECTOR
  7339. - int VAR_RECT
  7340. - int VAR_INTVECTOR3
  7341. - int VAR_INT64
  7342. - int MAX_VAR_TYPES
  7343. ### VertexElementSemantic
  7344. - int SEM_POSITION
  7345. - int SEM_NORMAL
  7346. - int SEM_BINORMAL
  7347. - int SEM_TANGENT
  7348. - int SEM_TEXCOORD
  7349. - int SEM_COLOR
  7350. - int SEM_BLENDWEIGHTS
  7351. - int SEM_BLENDINDICES
  7352. - int SEM_OBJECTINDEX
  7353. - int MAX_VERTEX_ELEMENT_SEMANTICS
  7354. ### VertexElementType
  7355. - int TYPE_INT
  7356. - int TYPE_FLOAT
  7357. - int TYPE_VECTOR2
  7358. - int TYPE_VECTOR3
  7359. - int TYPE_VECTOR4
  7360. - int TYPE_UBYTE4
  7361. - int TYPE_UBYTE4_NORM
  7362. - int MAX_VERTEX_ELEMENT_TYPES
  7363. ### VerticalAlignment
  7364. - int VA_TOP
  7365. - int VA_CENTER
  7366. - int VA_BOTTOM
  7367. - int VA_CUSTOM
  7368. ### WindowDragMode
  7369. - int DRAG_NONE
  7370. - int DRAG_MOVE
  7371. - int DRAG_RESIZE_TOPLEFT
  7372. - int DRAG_RESIZE_TOP
  7373. - int DRAG_RESIZE_TOPRIGHT
  7374. - int DRAG_RESIZE_RIGHT
  7375. - int DRAG_RESIZE_BOTTOMRIGHT
  7376. - int DRAG_RESIZE_BOTTOM
  7377. - int DRAG_RESIZE_BOTTOMLEFT
  7378. - int DRAG_RESIZE_LEFT
  7379. ### WrapMode
  7380. - int WM_LOOP
  7381. - int WM_ONCE
  7382. - int WM_CLAMP
  7383. \section LuaScriptAPI_toluaFunctions tolua functions
  7384. - lua_usertype cast(lua_usertype object, const char* typename)
  7385. - lua_table getpeer(lua_userdata object)
  7386. - void inherit(lua_table table, lua_usertype c_instance)
  7387. - bool releaseownership(lua_usertype object)
  7388. - void setpeer(lua_userdata object, lua_table table)
  7389. - bool takeownership(lua_usertype object)
  7390. - const char* type(lua_object object)
  7391. \section LuaScriptAPI_GlobalFunctions Global functions
  7392. - float Abs(float value)
  7393. - int AbsInt(int value)
  7394. - float Acos(float x)
  7395. - String AddTrailingSlash(const String pathName)
  7396. - float Asin(float x)
  7397. - float Atan(float x)
  7398. - float Atan2(float y, float x)
  7399. - float Ceil(float x)
  7400. - int CeilToInt(float x)
  7401. - float Clamp(float value, float min, float max)
  7402. - int ClampInt(int value, int min, int max)
  7403. - VectorBuffer CompressVectorBuffer(VectorBuffer& src)
  7404. - float Cos(float angle)
  7405. - unsigned CountSetBits(unsigned value)
  7406. - VectorBuffer DecompressVectorBuffer(VectorBuffer& src)
  7407. - bool Equals(float lhs, float rhs)
  7408. - void ErrorDialog(const String title, const String message)
  7409. - void ErrorExit(const String message = String::EMPTY, int exitCode = EXIT_FAILURE)
  7410. - float Floor(float x)
  7411. - int FloorToInt(float x)
  7412. - float Fract(float x)
  7413. - const Vector<String>& GetArguments()
  7414. - Audio* GetAudio()
  7415. - ResourceCache* GetCache()
  7416. - Console* GetConsole()
  7417. - String GetConsoleInput()
  7418. - Context* GetContext()
  7419. - DBAPI GetDBAPI()
  7420. - Database* GetDatabase()
  7421. - DebugHud* GetDebugHud()
  7422. - Engine* GetEngine()
  7423. - EventHandler* GetEventHandler() const
  7424. - Object* GetEventSender()
  7425. - bool GetExecuteConsoleCommands()
  7426. - String GetExtension(const String fullPath, bool lowercaseExtension = true)
  7427. - String GetFileName(const String fullPath)
  7428. - String GetFileNameAndExtension(const String fullPath, bool lowercaseExtension = false)
  7429. - String GetFileSizeString(long memorySize)
  7430. - FileSystem* GetFileSystem()
  7431. - Variant GetGlobalVar(const String key)
  7432. - VariantMap& GetGlobalVars()
  7433. - Graphics* GetGraphics()
  7434. - Input* GetInput()
  7435. - String GetInternalPath(const String pathName)
  7436. - Localization* GetLocalization()
  7437. - Log* GetLog()
  7438. - String GetMiniDumpDir()
  7439. - String GetNativePath(const String pathName)
  7440. - Network* GetNetwork()
  7441. - unsigned GetNumLogicalCPUs()
  7442. - unsigned GetNumPhysicalCPUs()
  7443. - String GetParentPath(const String pathName)
  7444. - String GetPath(const String fullPath)
  7445. - String GetPlatform()
  7446. - unsigned long long GetTotalMemory()
  7447. - String GetLoginName()
  7448. - String GetHostName()
  7449. - String GetOSVersion()
  7450. - unsigned GetRandomSeed()
  7451. - Renderer* GetRenderer()
  7452. - Time* GetTime()
  7453. - UI* GetUI()
  7454. - bool HasSubscribedToEvent(Object* sender, const String eventName)
  7455. - bool HasSubscribedToEvent(const String eventName)
  7456. - float InverseLerp(float lhs, float rhs, float x)
  7457. - bool IsAbsolutePath(const String pathName)
  7458. - bool IsAlpha(unsigned ch)
  7459. - bool IsDigit(unsigned ch)
  7460. - bool IsNaN(float value)
  7461. - bool IsPowerOfTwo(unsigned value)
  7462. - float Lerp(float lhs, float rhs, float t)
  7463. - float Ln(float x)
  7464. - float Max(float lhs, float rhs)
  7465. - int MaxInt(int lhs, int rhs)
  7466. - float Min(float lhs, float rhs)
  7467. - int MinInt(int lhs, int rhs)
  7468. - float Mod(float x, float y)
  7469. - unsigned NextPowerOfTwo(unsigned value)
  7470. - void OpenConsoleWindow()
  7471. - float Pow(float x, float y)
  7472. - void PrintLine(const String str, bool error = false)
  7473. - int Rand()
  7474. - float RandStandardNormal()
  7475. - float Random(float min, float max)
  7476. - float Random(float range)
  7477. - float Random()
  7478. - int RandomInt(int range)
  7479. - int RandomInt(int min, int max)
  7480. - float RandomNormal(float meanValue, float variance)
  7481. - void RegisterEventName(const String eventName)
  7482. - String RemoveTrailingSlash(const String pathName)
  7483. - String ReplaceExtension(const String fullPath, const String newExtension)
  7484. - float Round(float x)
  7485. - int RoundToInt(float x)
  7486. - unsigned SDBMHash(unsigned hash, char c)
  7487. - void SendEvent(const String eventName, VariantMap& eventData)
  7488. - void SetExecuteConsoleCommands(bool enable)
  7489. - void SetGlobalVar(const String key, Variant value)
  7490. - void SetMiniDumpDir(const String pathName)
  7491. - void SetRandomSeed(unsigned seed)
  7492. - float Sign(float value)
  7493. - float Sin(float angle)
  7494. - float SmoothStep(float lhs, float rhs, float t)
  7495. - float Sqrt(float x)
  7496. - float StableRandom(const Vector3& seed)
  7497. - float StableRandom(float seed)
  7498. - float StableRandom(const Vector2& seed)
  7499. - void SubscribeToEvent(const String eventName, void* functionOrFunctionName)
  7500. - void SubscribeToEvent(void* sender, const String eventName, void* functionOrFunctionName)
  7501. - float Tan(float angle)
  7502. - bool ToBool(const String source)
  7503. - Color ToColor(const String source)
  7504. - float ToFloat(const String source)
  7505. - int ToInt(const String source, int base = 10)
  7506. - int ToInt64(const String source, int base = 10)
  7507. - IntRect ToIntRect(const String source)
  7508. - IntVector2 ToIntVector2(const String source)
  7509. - IntVector3 ToIntVector3(const String source)
  7510. - unsigned ToLower(unsigned ch)
  7511. - Matrix3 ToMatrix3(const String source)
  7512. - Matrix3x4 ToMatrix3x4(const String source)
  7513. - Matrix4 ToMatrix4(const String source)
  7514. - Quaternion ToQuaternion(const String source)
  7515. - Rect ToRect(const String source)
  7516. - String ToString(void* value)
  7517. - String ToStringHex(unsigned value)
  7518. - unsigned ToUInt(const String source, int base = 10)
  7519. - int ToUInt64(const String source, int base = 10)
  7520. - unsigned ToUpper(unsigned ch)
  7521. - Vector2 ToVector2(const String source)
  7522. - Vector3 ToVector3(const String source)
  7523. - Vector4 ToVector4(const String source, bool allowMissingCoords = false)
  7524. - void UnsubscribeFromAllEvents()
  7525. - void UnsubscribeFromAllEventsExcept(const Vector<String>& exceptionNames)
  7526. - void UnsubscribeFromEvent(Object* sender, const String eventName)
  7527. - void UnsubscribeFromEvent(const String eventName)
  7528. - void UnsubscribeFromEvents(Object* sender)
  7529. - Vector2 VectorCeil(const Vector2& vec)
  7530. - Vector4 VectorCeil(const Vector4& vec)
  7531. - Vector3 VectorCeil(const Vector3& vec)
  7532. - IntVector3 VectorCeilToInt(const Vector3& vec)
  7533. - IntVector2 VectorCeilToInt(const Vector2& vec)
  7534. - Vector2 VectorFloor(const Vector2& vec)
  7535. - Vector3 VectorFloor(const Vector3& vec)
  7536. - Vector4 VectorFloor(const Vector4& vec)
  7537. - IntVector2 VectorFloorToInt(const Vector2& vec)
  7538. - IntVector3 VectorFloorToInt(const Vector3& vec)
  7539. - Vector2 VectorLerp(const Vector2& lhs, const Vector2& rhs, const Vector2& t)
  7540. - Vector4 VectorLerp(const Vector4& lhs, const Vector4& rhs, const Vector4& t)
  7541. - Vector3 VectorLerp(const Vector3& lhs, const Vector3& rhs, const Vector3& t)
  7542. - Vector4 VectorMax(const Vector4& lhs, const Vector4& rhs)
  7543. - Vector2 VectorMax(const Vector2& lhs, const Vector2& rhs)
  7544. - IntVector2 VectorMax(const IntVector2& lhs, const IntVector2& rhs)
  7545. - IntVector3 VectorMax(const IntVector3& lhs, const IntVector3& rhs)
  7546. - Vector3 VectorMax(const Vector3& lhs, const Vector3& rhs)
  7547. - Vector2 VectorMin(const Vector2& lhs, const Vector2& rhs)
  7548. - IntVector3 VectorMin(const IntVector3& lhs, const IntVector3& rhs)
  7549. - Vector4 VectorMin(const Vector4& lhs, const Vector4& rhs)
  7550. - Vector3 VectorMin(const Vector3& lhs, const Vector3& rhs)
  7551. - IntVector2 VectorMin(const IntVector2& lhs, const IntVector2& rhs)
  7552. - Vector4 VectorRound(const Vector4& vec)
  7553. - Vector2 VectorRound(const Vector2& vec)
  7554. - Vector3 VectorRound(const Vector3& vec)
  7555. - IntVector3 VectorRoundToInt(const Vector3& vec)
  7556. - IntVector2 VectorRoundToInt(const Vector2& vec)
  7557. \section LuaScriptAPI_GlobalProperties Global properties
  7558. - Audio* audio (readonly)
  7559. - ResourceCache* cache (readonly)
  7560. - Console* console (readonly)
  7561. - Context* context (readonly)
  7562. - Database* database (readonly)
  7563. - DebugHud* debugHud (readonly)
  7564. - Engine* engine (readonly)
  7565. - EventHandler* eventHandler (readonly)
  7566. - EventSender* eventSender (readonly)
  7567. - FileSystem* fileSystem (readonly)
  7568. - Graphics* graphics (readonly)
  7569. - Input* input (readonly)
  7570. - Localization* localization (readonly)
  7571. - Log* log (readonly)
  7572. - Network* network (readonly)
  7573. - Renderer* renderer (readonly)
  7574. - Time* time (readonly)
  7575. - UI* ui (readonly)
  7576. \section LuaScriptAPI_GlobalConstants Global constants
  7577. - float ANIMATION_LOD_BASESCALE
  7578. - char CHANNEL_POSITION
  7579. - char CHANNEL_ROTATION
  7580. - char CHANNEL_SCALE
  7581. - unsigned CLEAR_COLOR
  7582. - unsigned CLEAR_DEPTH
  7583. - unsigned CLEAR_STENCIL
  7584. - int CONTROLLER_AXIS_LEFTX
  7585. - int CONTROLLER_AXIS_LEFTY
  7586. - int CONTROLLER_AXIS_RIGHTX
  7587. - int CONTROLLER_AXIS_RIGHTY
  7588. - int CONTROLLER_AXIS_TRIGGERLEFT
  7589. - int CONTROLLER_AXIS_TRIGGERRIGHT
  7590. - int CONTROLLER_BUTTON_A
  7591. - int CONTROLLER_BUTTON_B
  7592. - int CONTROLLER_BUTTON_BACK
  7593. - int CONTROLLER_BUTTON_DPAD_DOWN
  7594. - int CONTROLLER_BUTTON_DPAD_LEFT
  7595. - int CONTROLLER_BUTTON_DPAD_RIGHT
  7596. - int CONTROLLER_BUTTON_DPAD_UP
  7597. - int CONTROLLER_BUTTON_GUIDE
  7598. - int CONTROLLER_BUTTON_LEFTSHOULDER
  7599. - int CONTROLLER_BUTTON_LEFTSTICK
  7600. - int CONTROLLER_BUTTON_RIGHTSHOULDER
  7601. - int CONTROLLER_BUTTON_RIGHTSTICK
  7602. - int CONTROLLER_BUTTON_START
  7603. - int CONTROLLER_BUTTON_X
  7604. - int CONTROLLER_BUTTON_Y
  7605. - unsigned DD_DISABLED
  7606. - unsigned DD_SOURCE
  7607. - unsigned DD_SOURCE_AND_TARGET
  7608. - unsigned DD_TARGET
  7609. - unsigned DEBUGHUD_SHOW_ALL
  7610. - unsigned DEBUGHUD_SHOW_EVENTPROFILER
  7611. - unsigned DEBUGHUD_SHOW_MEMORY
  7612. - unsigned DEBUGHUD_SHOW_MODE
  7613. - unsigned DEBUGHUD_SHOW_NONE
  7614. - unsigned DEBUGHUD_SHOW_PROFILER
  7615. - unsigned DEBUGHUD_SHOW_STATS
  7616. - unsigned DEFAULT_LIGHTMASK
  7617. - unsigned DEFAULT_SHADOWMASK
  7618. - unsigned DEFAULT_VIEWMASK
  7619. - unsigned DEFAULT_ZONEMASK
  7620. - unsigned DRAWABLE_ANY
  7621. - unsigned DRAWABLE_GEOMETRY
  7622. - unsigned DRAWABLE_GEOMETRY2D
  7623. - unsigned DRAWABLE_LIGHT
  7624. - unsigned DRAWABLE_ZONE
  7625. - unsigned FIRST_LOCAL_ID
  7626. - unsigned FIRST_REPLICATED_ID
  7627. - int HAT_CENTER
  7628. - int HAT_DOWN
  7629. - int HAT_LEFT
  7630. - int HAT_RIGHT
  7631. - int HAT_UP
  7632. - int KEY_0
  7633. - int KEY_1
  7634. - int KEY_2
  7635. - int KEY_3
  7636. - int KEY_4
  7637. - int KEY_5
  7638. - int KEY_6
  7639. - int KEY_7
  7640. - int KEY_8
  7641. - int KEY_9
  7642. - int KEY_A
  7643. - int KEY_ALT
  7644. - int KEY_APPLICATION
  7645. - int KEY_B
  7646. - int KEY_BACKSPACE
  7647. - int KEY_C
  7648. - int KEY_CAPSLOCK
  7649. - int KEY_CTRL
  7650. - int KEY_D
  7651. - int KEY_DELETE
  7652. - int KEY_DOWN
  7653. - int KEY_E
  7654. - int KEY_END
  7655. - int KEY_ESCAPE
  7656. - int KEY_F
  7657. - int KEY_F1
  7658. - int KEY_F10
  7659. - int KEY_F11
  7660. - int KEY_F12
  7661. - int KEY_F13
  7662. - int KEY_F14
  7663. - int KEY_F15
  7664. - int KEY_F16
  7665. - int KEY_F17
  7666. - int KEY_F18
  7667. - int KEY_F19
  7668. - int KEY_F2
  7669. - int KEY_F20
  7670. - int KEY_F21
  7671. - int KEY_F22
  7672. - int KEY_F23
  7673. - int KEY_F24
  7674. - int KEY_F3
  7675. - int KEY_F4
  7676. - int KEY_F5
  7677. - int KEY_F6
  7678. - int KEY_F7
  7679. - int KEY_F8
  7680. - int KEY_F9
  7681. - int KEY_G
  7682. - int KEY_GUI
  7683. - int KEY_H
  7684. - int KEY_HOME
  7685. - int KEY_I
  7686. - int KEY_INSERT
  7687. - int KEY_J
  7688. - int KEY_K
  7689. - int KEY_KP_0
  7690. - int KEY_KP_1
  7691. - int KEY_KP_2
  7692. - int KEY_KP_3
  7693. - int KEY_KP_4
  7694. - int KEY_KP_5
  7695. - int KEY_KP_6
  7696. - int KEY_KP_7
  7697. - int KEY_KP_8
  7698. - int KEY_KP_9
  7699. - int KEY_KP_DIVIDE
  7700. - int KEY_KP_ENTER
  7701. - int KEY_KP_MINUS
  7702. - int KEY_KP_MULTIPLY
  7703. - int KEY_KP_PERIOD
  7704. - int KEY_KP_PLUS
  7705. - int KEY_L
  7706. - int KEY_LALT
  7707. - int KEY_LCTRL
  7708. - int KEY_LEFT
  7709. - int KEY_LGUI
  7710. - int KEY_LSHIFT
  7711. - int KEY_M
  7712. - int KEY_N
  7713. - int KEY_NUMLOCKCLEAR
  7714. - int KEY_O
  7715. - int KEY_P
  7716. - int KEY_PAGEDOWN
  7717. - int KEY_PAGEUP
  7718. - int KEY_PAUSE
  7719. - int KEY_PRINTSCREEN
  7720. - int KEY_Q
  7721. - int KEY_R
  7722. - int KEY_RALT
  7723. - int KEY_RCTRL
  7724. - int KEY_RETURN
  7725. - int KEY_RETURN2
  7726. - int KEY_RGUI
  7727. - int KEY_RIGHT
  7728. - int KEY_RSHIFT
  7729. - int KEY_S
  7730. - int KEY_SCROLLLOCK
  7731. - int KEY_SELECT
  7732. - int KEY_SHIFT
  7733. - int KEY_SPACE
  7734. - int KEY_T
  7735. - int KEY_TAB
  7736. - int KEY_U
  7737. - int KEY_UNKNOWN
  7738. - int KEY_UP
  7739. - int KEY_V
  7740. - int KEY_W
  7741. - int KEY_X
  7742. - int KEY_Y
  7743. - int KEY_Z
  7744. - unsigned LAST_LOCAL_ID
  7745. - unsigned LAST_REPLICATED_ID
  7746. - int LOG_DEBUG
  7747. - int LOG_ERROR
  7748. - int LOG_INFO
  7749. - int LOG_NONE
  7750. - int LOG_WARNING
  7751. - unsigned MASK_BLENDINDICES
  7752. - unsigned MASK_BLENDWEIGHTS
  7753. - unsigned MASK_COLOR
  7754. - unsigned MASK_CUBETEXCOORD1
  7755. - unsigned MASK_CUBETEXCOORD2
  7756. - unsigned MASK_INSTANCEMATRIX1
  7757. - unsigned MASK_INSTANCEMATRIX2
  7758. - unsigned MASK_INSTANCEMATRIX3
  7759. - unsigned MASK_NONE
  7760. - unsigned MASK_NORMAL
  7761. - unsigned MASK_OBJECTINDEX
  7762. - unsigned MASK_POSITION
  7763. - unsigned MASK_TANGENT
  7764. - unsigned MASK_TEXCOORD1
  7765. - unsigned MASK_TEXCOORD2
  7766. - int MAX_VERTEX_LIGHTS
  7767. - int MOUSEB_LEFT
  7768. - int MOUSEB_MIDDLE
  7769. - int MOUSEB_RIGHT
  7770. - float M_DEGTORAD
  7771. - float M_DEGTORAD_2
  7772. - float M_EPSILON
  7773. - float M_HALF_PI
  7774. - float M_INFINITY
  7775. - float M_LARGE_EPSILON
  7776. - float M_LARGE_VALUE
  7777. - float M_MAX_FOV
  7778. - int M_MAX_INT
  7779. - unsigned M_MAX_UNSIGNED
  7780. - int M_MIN_INT
  7781. - float M_MIN_NEARCLIP
  7782. - unsigned M_MIN_UNSIGNED
  7783. - float M_PI
  7784. - float M_RADTODEG
  7785. - unsigned NUM_FRUSTUM_PLANES
  7786. - unsigned NUM_FRUSTUM_VERTICES
  7787. - float PIXEL_SIZE
  7788. - int QUALITY_HIGH
  7789. - int QUALITY_LOW
  7790. - int QUALITY_MAX
  7791. - int QUALITY_MEDIUM
  7792. - int QUAL_ALT
  7793. - int QUAL_ANY
  7794. - int QUAL_CTRL
  7795. - int QUAL_SHIFT
  7796. - int SCANCODE_0
  7797. - int SCANCODE_1
  7798. - int SCANCODE_2
  7799. - int SCANCODE_3
  7800. - int SCANCODE_4
  7801. - int SCANCODE_5
  7802. - int SCANCODE_6
  7803. - int SCANCODE_7
  7804. - int SCANCODE_8
  7805. - int SCANCODE_9
  7806. - int SCANCODE_A
  7807. - int SCANCODE_AC_BACK
  7808. - int SCANCODE_AC_BOOKMARKS
  7809. - int SCANCODE_AC_FORWARD
  7810. - int SCANCODE_AC_HOME
  7811. - int SCANCODE_AC_REFRESH
  7812. - int SCANCODE_AC_SEARCH
  7813. - int SCANCODE_AC_STOP
  7814. - int SCANCODE_AGAIN
  7815. - int SCANCODE_ALT
  7816. - int SCANCODE_ALTERASE
  7817. - int SCANCODE_APOSTROPHE
  7818. - int SCANCODE_APP1
  7819. - int SCANCODE_APP2
  7820. - int SCANCODE_APPLICATION
  7821. - int SCANCODE_AUDIOMUTE
  7822. - int SCANCODE_AUDIONEXT
  7823. - int SCANCODE_AUDIOPLAY
  7824. - int SCANCODE_AUDIOPREV
  7825. - int SCANCODE_AUDIOSTOP
  7826. - int SCANCODE_B
  7827. - int SCANCODE_BACKSLASH
  7828. - int SCANCODE_BACKSPACE
  7829. - int SCANCODE_BRIGHTNESSDOWN
  7830. - int SCANCODE_BRIGHTNESSUP
  7831. - int SCANCODE_C
  7832. - int SCANCODE_CALCULATOR
  7833. - int SCANCODE_CANCEL
  7834. - int SCANCODE_CAPSLOCK
  7835. - int SCANCODE_CLEAR
  7836. - int SCANCODE_CLEARAGAIN
  7837. - int SCANCODE_COMMA
  7838. - int SCANCODE_COMPUTER
  7839. - int SCANCODE_COPY
  7840. - int SCANCODE_CRSEL
  7841. - int SCANCODE_CTRL
  7842. - int SCANCODE_CURRENCYSUBUNIT
  7843. - int SCANCODE_CURRENCYUNIT
  7844. - int SCANCODE_CUT
  7845. - int SCANCODE_D
  7846. - int SCANCODE_DECIMALSEPARATOR
  7847. - int SCANCODE_DELETE
  7848. - int SCANCODE_DISPLAYSWITCH
  7849. - int SCANCODE_DOWN
  7850. - int SCANCODE_E
  7851. - int SCANCODE_EJECT
  7852. - int SCANCODE_END
  7853. - int SCANCODE_EQUALS
  7854. - int SCANCODE_ESCAPE
  7855. - int SCANCODE_EXECUTE
  7856. - int SCANCODE_EXSEL
  7857. - int SCANCODE_F
  7858. - int SCANCODE_F1
  7859. - int SCANCODE_F10
  7860. - int SCANCODE_F11
  7861. - int SCANCODE_F12
  7862. - int SCANCODE_F13
  7863. - int SCANCODE_F14
  7864. - int SCANCODE_F15
  7865. - int SCANCODE_F16
  7866. - int SCANCODE_F17
  7867. - int SCANCODE_F18
  7868. - int SCANCODE_F19
  7869. - int SCANCODE_F2
  7870. - int SCANCODE_F20
  7871. - int SCANCODE_F21
  7872. - int SCANCODE_F22
  7873. - int SCANCODE_F23
  7874. - int SCANCODE_F24
  7875. - int SCANCODE_F3
  7876. - int SCANCODE_F4
  7877. - int SCANCODE_F5
  7878. - int SCANCODE_F6
  7879. - int SCANCODE_F7
  7880. - int SCANCODE_F8
  7881. - int SCANCODE_F9
  7882. - int SCANCODE_FIND
  7883. - int SCANCODE_G
  7884. - int SCANCODE_GRAVE
  7885. - int SCANCODE_GUI
  7886. - int SCANCODE_H
  7887. - int SCANCODE_HELP
  7888. - int SCANCODE_HOME
  7889. - int SCANCODE_I
  7890. - int SCANCODE_INSERT
  7891. - int SCANCODE_INTERNATIONAL1
  7892. - int SCANCODE_INTERNATIONAL2
  7893. - int SCANCODE_INTERNATIONAL3
  7894. - int SCANCODE_INTERNATIONAL4
  7895. - int SCANCODE_INTERNATIONAL5
  7896. - int SCANCODE_INTERNATIONAL6
  7897. - int SCANCODE_INTERNATIONAL7
  7898. - int SCANCODE_INTERNATIONAL8
  7899. - int SCANCODE_INTERNATIONAL9
  7900. - int SCANCODE_J
  7901. - int SCANCODE_K
  7902. - int SCANCODE_KBDILLUMDOWN
  7903. - int SCANCODE_KBDILLUMTOGGLE
  7904. - int SCANCODE_KBDILLUMUP
  7905. - int SCANCODE_KP_0
  7906. - int SCANCODE_KP_00
  7907. - int SCANCODE_KP_000
  7908. - int SCANCODE_KP_1
  7909. - int SCANCODE_KP_2
  7910. - int SCANCODE_KP_3
  7911. - int SCANCODE_KP_4
  7912. - int SCANCODE_KP_5
  7913. - int SCANCODE_KP_6
  7914. - int SCANCODE_KP_7
  7915. - int SCANCODE_KP_8
  7916. - int SCANCODE_KP_9
  7917. - int SCANCODE_KP_A
  7918. - int SCANCODE_KP_AMPERSAND
  7919. - int SCANCODE_KP_AT
  7920. - int SCANCODE_KP_B
  7921. - int SCANCODE_KP_BACKSPACE
  7922. - int SCANCODE_KP_BINARY
  7923. - int SCANCODE_KP_C
  7924. - int SCANCODE_KP_CLEAR
  7925. - int SCANCODE_KP_CLEARENTRY
  7926. - int SCANCODE_KP_COLON
  7927. - int SCANCODE_KP_COMMA
  7928. - int SCANCODE_KP_D
  7929. - int SCANCODE_KP_DBLAMPERSAND
  7930. - int SCANCODE_KP_DBLVERTICALBAR
  7931. - int SCANCODE_KP_DECIMAL
  7932. - int SCANCODE_KP_DIVIDE
  7933. - int SCANCODE_KP_E
  7934. - int SCANCODE_KP_ENTER
  7935. - int SCANCODE_KP_EQUALS
  7936. - int SCANCODE_KP_EQUALSAS400
  7937. - int SCANCODE_KP_EXCLAM
  7938. - int SCANCODE_KP_F
  7939. - int SCANCODE_KP_GREATER
  7940. - int SCANCODE_KP_HASH
  7941. - int SCANCODE_KP_HEXADECIMAL
  7942. - int SCANCODE_KP_LEFTBRACE
  7943. - int SCANCODE_KP_LEFTPAREN
  7944. - int SCANCODE_KP_LESS
  7945. - int SCANCODE_KP_MEMADD
  7946. - int SCANCODE_KP_MEMCLEAR
  7947. - int SCANCODE_KP_MEMDIVIDE
  7948. - int SCANCODE_KP_MEMMULTIPLY
  7949. - int SCANCODE_KP_MEMRECALL
  7950. - int SCANCODE_KP_MEMSTORE
  7951. - int SCANCODE_KP_MEMSUBTRACT
  7952. - int SCANCODE_KP_MINUS
  7953. - int SCANCODE_KP_MULTIPLY
  7954. - int SCANCODE_KP_OCTAL
  7955. - int SCANCODE_KP_PERCENT
  7956. - int SCANCODE_KP_PERIOD
  7957. - int SCANCODE_KP_PLUS
  7958. - int SCANCODE_KP_PLUSMINUS
  7959. - int SCANCODE_KP_POWER
  7960. - int SCANCODE_KP_RIGHTBRACE
  7961. - int SCANCODE_KP_RIGHTPAREN
  7962. - int SCANCODE_KP_SPACE
  7963. - int SCANCODE_KP_TAB
  7964. - int SCANCODE_KP_VERTICALBAR
  7965. - int SCANCODE_KP_XOR
  7966. - int SCANCODE_L
  7967. - int SCANCODE_LALT
  7968. - int SCANCODE_LANG1
  7969. - int SCANCODE_LANG2
  7970. - int SCANCODE_LANG3
  7971. - int SCANCODE_LANG4
  7972. - int SCANCODE_LANG5
  7973. - int SCANCODE_LANG6
  7974. - int SCANCODE_LANG7
  7975. - int SCANCODE_LANG8
  7976. - int SCANCODE_LANG9
  7977. - int SCANCODE_LCTRL
  7978. - int SCANCODE_LEFT
  7979. - int SCANCODE_LEFTBRACKET
  7980. - int SCANCODE_LGUI
  7981. - int SCANCODE_LSHIFT
  7982. - int SCANCODE_M
  7983. - int SCANCODE_MAIL
  7984. - int SCANCODE_MEDIASELECT
  7985. - int SCANCODE_MENU
  7986. - int SCANCODE_MINUS
  7987. - int SCANCODE_MODE
  7988. - int SCANCODE_MUTE
  7989. - int SCANCODE_N
  7990. - int SCANCODE_NONUSBACKSLASH
  7991. - int SCANCODE_NONUSHASH
  7992. - int SCANCODE_NUMLOCKCLEAR
  7993. - int SCANCODE_O
  7994. - int SCANCODE_OPER
  7995. - int SCANCODE_OUT
  7996. - int SCANCODE_P
  7997. - int SCANCODE_PAGEDOWN
  7998. - int SCANCODE_PAGEUP
  7999. - int SCANCODE_PASTE
  8000. - int SCANCODE_PAUSE
  8001. - int SCANCODE_PERIOD
  8002. - int SCANCODE_POWER
  8003. - int SCANCODE_PRINTSCREEN
  8004. - int SCANCODE_PRIOR
  8005. - int SCANCODE_Q
  8006. - int SCANCODE_R
  8007. - int SCANCODE_RALT
  8008. - int SCANCODE_RCTRL
  8009. - int SCANCODE_RETURN
  8010. - int SCANCODE_RETURN2
  8011. - int SCANCODE_RGUI
  8012. - int SCANCODE_RIGHT
  8013. - int SCANCODE_RIGHTBRACKET
  8014. - int SCANCODE_RSHIFT
  8015. - int SCANCODE_S
  8016. - int SCANCODE_SCROLLLOCK
  8017. - int SCANCODE_SELECT
  8018. - int SCANCODE_SEMICOLON
  8019. - int SCANCODE_SEPARATOR
  8020. - int SCANCODE_SHIFT
  8021. - int SCANCODE_SLASH
  8022. - int SCANCODE_SLEEP
  8023. - int SCANCODE_SPACE
  8024. - int SCANCODE_STOP
  8025. - int SCANCODE_SYSREQ
  8026. - int SCANCODE_T
  8027. - int SCANCODE_TAB
  8028. - int SCANCODE_THOUSANDSSEPARATOR
  8029. - int SCANCODE_U
  8030. - int SCANCODE_UNDO
  8031. - int SCANCODE_UNKNOWN
  8032. - int SCANCODE_UP
  8033. - int SCANCODE_V
  8034. - int SCANCODE_VOLUMEDOWN
  8035. - int SCANCODE_VOLUMEUP
  8036. - int SCANCODE_W
  8037. - int SCANCODE_WWW
  8038. - int SCANCODE_X
  8039. - int SCANCODE_Y
  8040. - int SCANCODE_Z
  8041. - unsigned SCAN_DIRS
  8042. - unsigned SCAN_FILES
  8043. - unsigned SCAN_HIDDEN
  8044. - String SOUND_AMBIENT
  8045. - String SOUND_EFFECT
  8046. - String SOUND_MASTER
  8047. - String SOUND_MUSIC
  8048. - String SOUND_VOICE
  8049. - unsigned VO_DISABLE_OCCLUSION
  8050. - unsigned VO_DISABLE_SHADOWS
  8051. - unsigned VO_LOW_MATERIAL_QUALITY
  8052. - unsigned VO_NONE
  8053. */
  8054. }