LuaScriptAPI.dox 234 KB

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