LuaScriptAPI.dox 246 KB

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