LuaScriptAPI.dox 251 KB

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