LuaScriptAPI.dox 229 KB

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