LuaScriptAPI.dox 232 KB

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