LuaScriptAPI.dox 234 KB

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