LuaScriptAPI.dox 252 KB

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