LuaScriptAPI.dox 232 KB

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