LuaScriptAPI.dox 231 KB

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