LuaScriptAPI.dox 275 KB

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