LuaScriptAPI.dox 235 KB

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