LuaScriptAPI.dox 235 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323
  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. - bool HasSubscribedToEvent(const String eventName)
  2695. - bool HasSubscribedToEvent(Object* sender, const String eventName)
  2696. - LuaFile* GetScriptFile() const
  2697. - const String GetScriptObjectType() const
  2698. Properties:
  2699. - const LuaFile* scriptFile
  2700. - const String scriptObjectType
  2701. <a name="Class_Material"></a>
  2702. ### Material : Resource
  2703. Methods:
  2704. - Material() (GC)
  2705. - Material* new()
  2706. - void delete()
  2707. - void SetNumTechniques(unsigned num)
  2708. - void SetTechnique(unsigned index, Technique* tech, unsigned qualityLevel = 0, float lodDistance = 0.0f)
  2709. - void SetShaderParameter(const String name, const Variant& value)
  2710. - void SetShaderParameterAnimation(const String name, ValueAnimation* animation, WrapMode wrapMode = WM_LOOP, float speed = 1.0f)
  2711. - void SetShaderParameterAnimationWrapMode(const String name, WrapMode wrapMode)
  2712. - void SetShaderParameterAnimationSpeed(const String name, float speed)
  2713. - void SetTexture(TextureUnit unit, Texture* texture)
  2714. - void SetUVTransform(const Vector2& offset, float rotation, const Vector2& repeat)
  2715. - void SetUVTransform(const Vector2& offset, float rotation, float repeat)
  2716. - void SetCullMode(CullMode mode)
  2717. - void SetShadowCullMode(CullMode mode)
  2718. - void SetFillMode(FillMode mode)
  2719. - void SetDepthBias(const BiasParameters& parameters)
  2720. - void SetRenderOrder(char renderOrder)
  2721. - void SetScene(Scene* scene)
  2722. - void RemoveShaderParameter(const String name)
  2723. - void ReleaseShaders()
  2724. - Material* Clone(const String cloneName = String::EMPTY) const
  2725. - void SortTechniques()
  2726. - void MarkForAuxView(unsigned frameNumber)
  2727. - unsigned GetNumTechniques() const
  2728. - Technique* GetTechnique(unsigned index) const
  2729. - Pass* GetPass(unsigned index, const String passName) const
  2730. - Texture* GetTexture(TextureUnit unit) const
  2731. - ValueAnimation* GetShaderParameterAnimation(const String name) const
  2732. - WrapMode GetShaderParameterAnimationWrapMode(const String name) const
  2733. - float GetShaderParameterAnimationSpeed(const String name) const
  2734. - CullMode GetCullMode() const
  2735. - CullMode GetShadowCullMode() const
  2736. - FillMode GetFillMode() const
  2737. - const BiasParameters& GetDepthBias() const
  2738. - char GetRenderOrder() const
  2739. - bool GetOcclusion() const
  2740. - bool GetSpecular() const
  2741. - Scene* GetScene() const
  2742. Properties:
  2743. - CullMode cullMode
  2744. - CullMode shadowCullMode
  2745. - FillMode fillMode
  2746. - BiasParameters depthBias
  2747. - char renderOrder
  2748. - bool occlusion (readonly)
  2749. - bool specular (readonly)
  2750. - Scene* scene
  2751. <a name="Class_Matrix3"></a>
  2752. ### Matrix3
  2753. Methods:
  2754. - Matrix3() (GC)
  2755. - Matrix3* new()
  2756. - Matrix3(const Matrix3& matrix) (GC)
  2757. - Matrix3* new(const Matrix3& matrix)
  2758. - Matrix3(float v00, float v01, float v02, float v10, float v11, float v12, float v20, float v21, float v22) (GC)
  2759. - Matrix3* new(float v00, float v01, float v02, float v10, float v11, float v12, float v20, float v21, float v22)
  2760. - void delete()
  2761. - bool operator==(const Matrix3& rhs) const
  2762. - Vector3 operator*(const Vector3& rhs) const
  2763. - Matrix3 operator+(const Matrix3& rhs) const
  2764. - Matrix3 operator-(const Matrix3& rhs) const
  2765. - Matrix3 operator*(float rhs) const
  2766. - Matrix3 operator*(const Matrix3& rhs) const
  2767. - void SetScale(const Vector3& scale)
  2768. - void SetScale(float scale)
  2769. - Vector3 Scale() const
  2770. - Matrix3 Transpose() const
  2771. - Matrix3 Scaled(const Vector3& scale) const
  2772. - bool Equals(const Matrix3& rhs) const
  2773. - Matrix3 Inverse() const
  2774. - String ToString() const
  2775. Properties:
  2776. - float m00
  2777. - float m01
  2778. - float m02
  2779. - float m10
  2780. - float m11
  2781. - float m12
  2782. - float m20
  2783. - float m21
  2784. - float m22
  2785. - const Matrix3 ZERO
  2786. - const Matrix3 IDENTITY
  2787. <a name="Class_Matrix3x4"></a>
  2788. ### Matrix3x4
  2789. Methods:
  2790. - Matrix3x4() (GC)
  2791. - Matrix3x4* new()
  2792. - Matrix3x4(const Matrix3x4& matrix) (GC)
  2793. - Matrix3x4* new(const Matrix3x4& matrix)
  2794. - Matrix3x4(const Matrix3& matrix) (GC)
  2795. - Matrix3x4* new(const Matrix3& matrix)
  2796. - Matrix3x4(const Matrix4& matrix) (GC)
  2797. - Matrix3x4* new(const Matrix4& matrix)
  2798. - 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)
  2799. - 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)
  2800. - Matrix3x4(const Vector3& translation, const Quaternion& rotation, float scale) (GC)
  2801. - Matrix3x4* new(const Vector3& translation, const Quaternion& rotation, float scale)
  2802. - Matrix3x4(const Vector3& translation, const Quaternion& rotation, const Vector3& scale) (GC)
  2803. - Matrix3x4* new(const Vector3& translation, const Quaternion& rotation, const Vector3& scale)
  2804. - void delete()
  2805. - bool operator==(const Matrix3x4& rhs) const
  2806. - Vector3 operator*(const Vector3& rhs) const
  2807. - Vector3 operator*(const Vector4& rhs) const
  2808. - Matrix3x4 operator+(const Matrix3x4& rhs) const
  2809. - Matrix3x4 operator-(const Matrix3x4& rhs) const
  2810. - Matrix3x4 operator*(float rhs) const
  2811. - Matrix3x4 operator*(const Matrix3x4& rhs) const
  2812. - Matrix4 operator*(const Matrix4& rhs) const
  2813. - void SetTranslation(const Vector3& translation)
  2814. - void SetRotation(const Matrix3& rotation)
  2815. - void SetScale(const Vector3& scale)
  2816. - void SetScale(float scale)
  2817. - Matrix3 ToMatrix3() const
  2818. - Matrix4 ToMatrix4() const
  2819. - Matrix3 RotationMatrix() const
  2820. - Vector3 Translation() const
  2821. - Quaternion Rotation() const
  2822. - Vector3 Scale() const
  2823. - bool Equals(const Matrix3x4& rhs) const
  2824. - void Decompose(Vector3& translation, Quaternion& rotation, Vector3& scale) const
  2825. - Matrix3x4 Inverse() const
  2826. - String ToString() const
  2827. Properties:
  2828. - float m00
  2829. - float m01
  2830. - float m02
  2831. - float m03
  2832. - float m10
  2833. - float m11
  2834. - float m12
  2835. - float m13
  2836. - float m20
  2837. - float m21
  2838. - float m22
  2839. - float m23
  2840. - const Matrix3x4 ZERO
  2841. - const Matrix3x4 IDENTITY
  2842. <a name="Class_Matrix4"></a>
  2843. ### Matrix4
  2844. Methods:
  2845. - Matrix4() (GC)
  2846. - Matrix4* new()
  2847. - Matrix4(const Matrix4& matrix) (GC)
  2848. - Matrix4* new(const Matrix4& matrix)
  2849. - Matrix4(const Matrix3& matrix) (GC)
  2850. - Matrix4* new(const Matrix3& matrix)
  2851. - 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)
  2852. - 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)
  2853. - void delete()
  2854. - bool operator==(const Matrix4& rhs) const
  2855. - Vector3 operator*(const Vector3& rhs) const
  2856. - Vector4 operator*(const Vector4& rhs) const
  2857. - Matrix4 operator+(const Matrix4& rhs) const
  2858. - Matrix4 operator-(const Matrix4& rhs) const
  2859. - Matrix4 operator*(float rhs) const
  2860. - Matrix4 operator*(const Matrix4& rhs) const
  2861. - Matrix4 operator*(const Matrix3x4& rhs) const
  2862. - void SetTranslation(const Vector3& translation)
  2863. - void SetRotation(const Matrix3& rotation)
  2864. - void SetScale(const Vector3& scale)
  2865. - void SetScale(float scale)
  2866. - Matrix3 ToMatrix3() const
  2867. - Matrix3 RotationMatrix() const
  2868. - Vector3 Translation() const
  2869. - Quaternion Rotation() const
  2870. - Vector3 Scale() const
  2871. - Matrix4 Transpose() const
  2872. - bool Equals(const Matrix4& rhs) const
  2873. - void Decompose(Vector3& translation, Quaternion& rotation, Vector3& scale) const
  2874. - Matrix4 Inverse() const
  2875. - String ToString() const
  2876. Properties:
  2877. - float m00
  2878. - float m01
  2879. - float m02
  2880. - float m03
  2881. - float m10
  2882. - float m11
  2883. - float m12
  2884. - float m13
  2885. - float m20
  2886. - float m21
  2887. - float m22
  2888. - float m23
  2889. - float m30
  2890. - float m31
  2891. - float m32
  2892. - float m33
  2893. - const Matrix4 ZERO
  2894. - const Matrix4 IDENTITY
  2895. <a name="Class_Menu"></a>
  2896. ### Menu : Button
  2897. Methods:
  2898. - Menu() (GC)
  2899. - Menu* new()
  2900. - void delete()
  2901. - void SetPopup(UIElement* element)
  2902. - void SetPopupOffset(const IntVector2& offset)
  2903. - void SetPopupOffset(int x, int y)
  2904. - void ShowPopup(bool enable)
  2905. - void SetAccelerator(int key, int qualifiers)
  2906. - UIElement* GetPopup() const
  2907. - const IntVector2& GetPopupOffset() const
  2908. - bool GetShowPopup() const
  2909. - int GetAcceleratorKey() const
  2910. - int GetAcceleratorQualifiers() const
  2911. Properties:
  2912. - UIElement* popup
  2913. - IntVector2& popupOffset
  2914. - bool showPopup
  2915. - int acceleratorKey (readonly)
  2916. - int acceleratorQualifiers (readonly)
  2917. <a name="Class_MessageBox"></a>
  2918. ### MessageBox : Object
  2919. Methods:
  2920. - MessageBox(const String messageString = String::EMPTY, const String titleString = String::EMPTY, XMLFile* layoutFile = 0, XMLFile* styleFile = 0) (GC)
  2921. - MessageBox* new(const String messageString = String::EMPTY, const String titleString = String::EMPTY, XMLFile* layoutFile = 0, XMLFile* styleFile = 0)
  2922. - void delete()
  2923. - void SetTitle(const String text)
  2924. - void SetMessage(const String text)
  2925. - const String GetTitle() const
  2926. - const String GetMessage() const
  2927. - UIElement* GetWindow() const
  2928. Properties:
  2929. - String title
  2930. - String message
  2931. - UIElement* window (readonly)
  2932. <a name="Class_Model"></a>
  2933. ### Model : Resource
  2934. Methods:
  2935. - Model() (GC)
  2936. - Model* new()
  2937. - void delete()
  2938. - Model* Clone(const String cloneName = String::EMPTY) const
  2939. - void SetBoundingBox(const BoundingBox& box)
  2940. - void SetNumGeometries(unsigned num)
  2941. - bool SetNumGeometryLodLevels(unsigned index, unsigned num)
  2942. - bool SetGeometry(unsigned index, unsigned lodLevel, Geometry* geometry)
  2943. - bool SetGeometryCenter(unsigned index, const Vector3& center)
  2944. - const BoundingBox& GetBoundingBox() const
  2945. - Skeleton& GetSkeleton()
  2946. - unsigned GetNumGeometries() const
  2947. - unsigned GetNumGeometryLodLevels(unsigned index) const
  2948. - Geometry* GetGeometry(unsigned index, unsigned lodLevel) const
  2949. - const Vector3& GetGeometryCenter(unsigned index) const
  2950. - unsigned GetNumMorphs() const
  2951. - const ModelMorph* GetMorph(const String name) const
  2952. - const ModelMorph* GetMorph(StringHash nameHash) const
  2953. - const ModelMorph* GetMorph(unsigned index) const
  2954. - unsigned GetMorphRangeStart(unsigned bufferIndex) const
  2955. - unsigned GetMorphRangeCount(unsigned bufferIndex) const
  2956. Properties:
  2957. - BoundingBox& boundingBox
  2958. - Skeleton skeleton (readonly)
  2959. - unsigned numGeometries
  2960. - unsigned numMorphs (readonly)
  2961. <a name="Class_NavArea"></a>
  2962. ### NavArea : Component
  2963. Methods:
  2964. - unsigned GetAreaID() const
  2965. - void SetAreaID(unsigned tolua_var_3)
  2966. - BoundingBox GetBoundingBox()
  2967. - void SetBoundingBox(const BoundingBox& bnds)
  2968. - BoundingBox GetWorldBoundingBox() const
  2969. Properties:
  2970. - unsigned areaID
  2971. - BoundingBox boundingBox
  2972. - BoundingBox worldBoundingBox (readonly)
  2973. <a name="Class_Navigable"></a>
  2974. ### Navigable : Component
  2975. Methods:
  2976. - void SetRecursive(bool enable)
  2977. - bool IsRecursive() const
  2978. Properties:
  2979. - bool recursive
  2980. <a name="Class_NavigationGeometryInfo"></a>
  2981. ### NavigationGeometryInfo
  2982. Properties:
  2983. - Component* component
  2984. - unsigned lodLevel
  2985. - Matrix3x4 transform
  2986. - BoundingBox boundingBox
  2987. <a name="Class_NavigationMesh"></a>
  2988. ### NavigationMesh : Component
  2989. Methods:
  2990. - void SetTileSize(int size)
  2991. - void SetCellSize(float size)
  2992. - void SetCellHeight(float height)
  2993. - void SetAgentHeight(float height)
  2994. - void SetAgentRadius(float radius)
  2995. - void SetAgentMaxClimb(float maxClimb)
  2996. - void SetAgentMaxSlope(float maxSlope)
  2997. - void SetRegionMinSize(float size)
  2998. - void SetRegionMergeSize(float size)
  2999. - void SetEdgeMaxLength(float length)
  3000. - void SetEdgeMaxError(float error)
  3001. - void SetDetailSampleDistance(float distance)
  3002. - void SetDetailSampleMaxError(float error)
  3003. - void SetPadding(const Vector3& padding)
  3004. - void SetAreaCost(unsigned areaID, float cost)
  3005. - bool Build()
  3006. - bool Build(const BoundingBox& boundingBox)
  3007. - void SetPartitionType(NavmeshPartitionType aType)
  3008. - void SetDrawOffMeshConnections(bool enable)
  3009. - void SetDrawNavAreas(bool enable)
  3010. - Vector3 FindNearestPoint(const Vector3& point)
  3011. - Vector3 FindNearestPoint(const Vector3& point, const Vector3& extents)
  3012. - Vector3 MoveAlongSurface(const Vector3& start, const Vector3& end)
  3013. - Vector3 MoveAlongSurface(const Vector3& start, const Vector3& end, const Vector3& extents, int maxVisited = 3)
  3014. - const PODVector<Vector3>& FindPath(const Vector3& start, const Vector3& end)
  3015. - const PODVector<Vector3>& FindPath(const Vector3& start, const Vector3& end, const Vector3& extents)
  3016. - Vector3 GetRandomPoint()
  3017. - Vector3 GetRandomPointInCircle(const Vector3& center, float radius)
  3018. - Vector3 GetRandomPointInCircle(const Vector3& center, float radius, const Vector3& extents)
  3019. - float GetDistanceToWall(const Vector3& point, float radius)
  3020. - float GetDistanceToWall(const Vector3& point, float radius, const Vector3& extents)
  3021. - Vector3 Raycast(const Vector3& start, const Vector3& end)
  3022. - Vector3 Raycast(const Vector3& start, const Vector3& end, const Vector3& extents)
  3023. - void DrawDebugGeometry(bool depthTest)
  3024. - int GetTileSize() const
  3025. - float GetCellSize() const
  3026. - float GetCellHeight() const
  3027. - float GetAgentHeight() const
  3028. - float GetAgentRadius() const
  3029. - float GetAgentMaxClimb() const
  3030. - float GetAgentMaxSlope() const
  3031. - float GetRegionMinSize() const
  3032. - float GetRegionMergeSize() const
  3033. - float GetEdgeMaxLength() const
  3034. - float GetEdgeMaxError() const
  3035. - float GetDetailSampleDistance() const
  3036. - float GetDetailSampleMaxError() const
  3037. - const Vector3& GetPadding() const
  3038. - float GetAreaCost(unsigned areaID) const
  3039. - bool IsInitialized() const
  3040. - const BoundingBox& GetBoundingBox() const
  3041. - BoundingBox GetWorldBoundingBox() const
  3042. - IntVector2 GetNumTiles() const
  3043. - NavmeshPartitionType GetPartitionType()
  3044. - bool GetDrawOffMeshConnections() const
  3045. - bool GetDrawNavAreas() const
  3046. Properties:
  3047. - int tileSize
  3048. - float cellSize
  3049. - float cellHeight
  3050. - float agentHeight
  3051. - float agentRadius
  3052. - float agentMaxClimb
  3053. - float agentMaxSlope
  3054. - float regionMinSize
  3055. - float regionMergeSize
  3056. - float edgeMaxLength
  3057. - float edgeMaxError
  3058. - float detailSampleDistance
  3059. - float detailSampleMaxError
  3060. - Vector3& padding
  3061. - NavmeshPartitionType partitionType
  3062. - bool drawOffMeshConnections
  3063. - bool drawNavAreas
  3064. - bool initialized (readonly)
  3065. - BoundingBox& boundingBox (readonly)
  3066. - BoundingBox worldBoundingBox (readonly)
  3067. - IntVector2 numTiles (readonly)
  3068. <a name="Class_Network"></a>
  3069. ### Network
  3070. Methods:
  3071. - bool Connect(const String address, short port, Scene* scene)
  3072. - bool Connect(const String address, short port, Scene* scene, const VariantMap& identity)
  3073. - void Disconnect(int waitMSec = 0)
  3074. - bool StartServer(short port)
  3075. - void StopServer()
  3076. - void BroadcastMessage(int msgID, bool reliable, bool inOrder, const VectorBuffer& msg, unsigned contentID = 0)
  3077. - void BroadcastRemoteEvent(StringHash eventType, bool inOrder)
  3078. - void BroadcastRemoteEvent(StringHash eventType, bool inOrder, const VariantMap& eventData)
  3079. - void BroadcastRemoteEvent(const String eventType, bool inOrder)
  3080. - void BroadcastRemoteEvent(const String eventType, bool inOrder, const VariantMap& eventData)
  3081. - void BroadcastRemoteEvent(Scene* scene, StringHash eventType, bool inOrder)
  3082. - void BroadcastRemoteEvent(Scene* scene, StringHash eventType, bool inOrder, const VariantMap& eventData)
  3083. - void BroadcastRemoteEvent(Scene* scene, const String eventType, bool inOrder)
  3084. - void BroadcastRemoteEvent(Scene* scene, const String eventType, bool inOrder, const VariantMap& eventData)
  3085. - void BroadcastRemoteEvent(Node* node, StringHash eventType, bool inOrder)
  3086. - void BroadcastRemoteEvent(Node* node, StringHash eventType, bool inOrder, const VariantMap& eventData)
  3087. - void BroadcastRemoteEvent(Node* node, const String eventType, bool inOrder)
  3088. - void BroadcastRemoteEvent(Node* node, const String eventType, bool inOrder, const VariantMap& eventData)
  3089. - void SetUpdateFps(int fps)
  3090. - void SetSimulatedLatency(int ms)
  3091. - void SetSimulatedPacketLoss(float loss)
  3092. - void RegisterRemoteEvent(StringHash eventType)
  3093. - void RegisterRemoteEvent(const String eventType)
  3094. - void UnregisterRemoteEvent(StringHash eventType)
  3095. - void UnregisterRemoteEvent(const String eventType)
  3096. - void UnregisterAllRemoteEvents()
  3097. - void SetPackageCacheDir(const String path)
  3098. - void SendPackageToClients(Scene* scene, PackageFile* package)
  3099. - HttpRequest* MakeHttpRequest(const String url, const String verb = String::EMPTY)
  3100. - HttpRequest* MakeHttpRequest(const String url, const String verb, const Vector<String>& headers, const String postData = String::EMPTY)
  3101. - int GetUpdateFps() const
  3102. - int GetSimulatedLatency() const
  3103. - float GetSimulatedPacketLoss() const
  3104. - Connection* GetServerConnection() const
  3105. - bool IsServerRunning() const
  3106. - bool CheckRemoteEvent(StringHash eventType) const
  3107. - const String GetPackageCacheDir() const
  3108. Properties:
  3109. - int updateFps
  3110. - int simulatedLatency
  3111. - float simulatedPacketLoss
  3112. - Connection* serverConnection (readonly)
  3113. - bool serverRunning (readonly)
  3114. - String packageCacheDir
  3115. <a name="Class_NetworkPriority"></a>
  3116. ### NetworkPriority : Component
  3117. Methods:
  3118. - void SetBasePriority(float priority)
  3119. - void SetDistanceFactor(float factor)
  3120. - void SetMinPriority(float priority)
  3121. - void SetAlwaysUpdateOwner(bool enable)
  3122. - float GetBasePriority() const
  3123. - float GetDistanceFactor() const
  3124. - float GetMinPriority() const
  3125. - bool GetAlwaysUpdateOwner() const
  3126. - bool CheckUpdate(float distance, float accumulator)
  3127. Properties:
  3128. - float basePriority
  3129. - float distanceFactor
  3130. - float minPriority
  3131. - bool alwaysUpdateOwner
  3132. <a name="Class_Node"></a>
  3133. ### Node : Animatable
  3134. Methods:
  3135. - Node() (GC)
  3136. - Node* new()
  3137. - void delete()
  3138. - bool SaveXML(File* dest, const String indentation = "\t") const
  3139. - bool SaveJSON(File* dest, const String indentation = "\t") const
  3140. - void SetName(const String name)
  3141. - void SetPosition(const Vector3& position)
  3142. - void SetPosition2D(const Vector2& position)
  3143. - void SetPosition2D(float x, float y)
  3144. - void SetRotation(const Quaternion& rotation)
  3145. - void SetRotation2D(float rotation)
  3146. - void SetDirection(const Vector3& direction)
  3147. - void SetScale(float scale)
  3148. - void SetScale(const Vector3& scale)
  3149. - void SetScale2D(const Vector2& scale)
  3150. - void SetScale2D(float x, float y)
  3151. - void SetTransform(const Vector3& position, const Quaternion& rotation)
  3152. - void SetTransform(const Vector3& position, const Quaternion& rotation, const Vector3& scale)
  3153. - void SetTransform(const Vector3& position, const Quaternion& rotation, float scale)
  3154. - void SetTransform2D(const Vector2& position, float rotation)
  3155. - void SetTransform2D(const Vector2& position, float rotation, const Vector2& scale)
  3156. - void SetTransform2D(const Vector2& position, float rotation, float scale)
  3157. - void SetWorldPosition(const Vector3& position)
  3158. - void SetWorldPosition2D(const Vector2& position)
  3159. - void SetWorldPosition2D(float x, float y)
  3160. - void SetWorldRotation(const Quaternion& rotation)
  3161. - void SetWorldRotation2D(float rotation)
  3162. - void SetWorldDirection(const Vector3& direction)
  3163. - void SetWorldScale(float scale)
  3164. - void SetWorldScale(const Vector3& scale)
  3165. - void SetWorldScale2D(const Vector2& scale)
  3166. - void SetWorldScale2D(float x, float y)
  3167. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation)
  3168. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation, const Vector3& scale)
  3169. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation, float scale)
  3170. - void SetWorldTransform2D(const Vector2& position, float rotation)
  3171. - void SetWorldTransform2D(const Vector2& position, float rotation, const Vector2& scale)
  3172. - void SetWorldTransform2D(const Vector2& position, float rotation, float scale)
  3173. - void Translate(const Vector3& delta, TransformSpace space = TS_LOCAL)
  3174. - void Translate2D(const Vector2& delta, TransformSpace space = TS_LOCAL)
  3175. - void Rotate(const Quaternion& delta, TransformSpace space = TS_LOCAL)
  3176. - void Rotate2D(float delta, TransformSpace space = TS_LOCAL)
  3177. - void RotateAround(const Vector3& point, const Quaternion& delta, TransformSpace space = TS_LOCAL)
  3178. - void RotateAround2D(const Vector2& point, float delta, TransformSpace space = TS_LOCAL)
  3179. - void Pitch(float angle, TransformSpace space = TS_LOCAL)
  3180. - void Yaw(float angle, TransformSpace space = TS_LOCAL)
  3181. - void Roll(float angle, TransformSpace space = TS_LOCAL)
  3182. - bool LookAt(const Vector3& target)
  3183. - bool LookAt(const Vector3& target, const Vector3& upAxis, TransformSpace space = TS_WORLD)
  3184. - void Scale(float scale)
  3185. - void Scale(const Vector3& scale)
  3186. - void Scale2D(const Vector2& scale)
  3187. - void SetEnabled(bool enable)
  3188. - void SetDeepEnabled(bool enable)
  3189. - void ResetDeepEnabled()
  3190. - void SetEnabledRecursive(bool enable)
  3191. - void SetOwner(Connection* owner)
  3192. - void MarkDirty()
  3193. - Node* CreateChild(const String name = String::EMPTY, CreateMode mode = REPLICATED, unsigned id = 0)
  3194. - void AddChild(Node* node, unsigned index = M_MAX_UNSIGNED)
  3195. - void RemoveChild(Node* node)
  3196. - void RemoveAllChildren()
  3197. - void RemoveChildren(bool removeReplicated, bool removeLocal, bool recursive)
  3198. - void RemoveComponent(Component* component)
  3199. - void RemoveComponent(StringHash type)
  3200. - void RemoveComponent(const String type)
  3201. - void RemoveComponents(bool removeReplicated, bool removeLocal)
  3202. - void RemoveComponents(const String type)
  3203. - void RemoveAllComponents()
  3204. - Node* Clone(CreateMode mode = REPLICATED)
  3205. - void Remove()
  3206. - void SetParent(Node* parent)
  3207. - void SetVar(StringHash key, const Variant& value)
  3208. - void AddListener(Component* component)
  3209. - void RemoveListener(Component* component)
  3210. - Component* CreateComponent(const String type, CreateMode mode = REPLICATED, unsigned id = 0)
  3211. - Component* GetOrCreateComponent(const String type, CreateMode mode = REPLICATED, unsigned id = 0)
  3212. - Component* CloneComponent(Component* component, unsigned id = 0)
  3213. - Component* CloneComponent(Component* component, CreateMode mode, unsigned id = 0)
  3214. - int CreateScriptObject(const String scriptObjectType)
  3215. - int CreateScriptObject(const String fileName, const String scriptObjectType)
  3216. - int GetScriptObject() const
  3217. - int GetScriptObject(const String scriptObjectType) const
  3218. - unsigned GetID() const
  3219. - const String GetName() const
  3220. - StringHash GetNameHash() const
  3221. - Node* GetParent() const
  3222. - Scene* GetScene() const
  3223. - bool IsEnabled() const
  3224. - bool IsEnabledSelf() const
  3225. - Connection* GetOwner() const
  3226. - const Vector3& GetPosition() const
  3227. - Vector2 GetPosition2D() const
  3228. - const Quaternion& GetRotation() const
  3229. - float GetRotation2D() const
  3230. - Vector3 GetDirection() const
  3231. - Vector3 GetUp() const
  3232. - Vector3 GetRight() const
  3233. - const Vector3& GetScale() const
  3234. - Vector2 GetScale2D() const
  3235. - Matrix3x4 GetTransform() const
  3236. - Vector3 GetWorldPosition() const
  3237. - Vector2 GetWorldPosition2D() const
  3238. - Quaternion GetWorldRotation() const
  3239. - float GetWorldRotation2D() const
  3240. - Vector3 GetWorldDirection() const
  3241. - Vector3 GetWorldUp() const
  3242. - Vector3 GetWorldRight() const
  3243. - Vector3 GetWorldScale() const
  3244. - Vector2 GetWorldScale2D() const
  3245. - const Matrix3x4& GetWorldTransform() const
  3246. - Vector3 LocalToWorld(const Vector3& position) const
  3247. - Vector3 LocalToWorld(const Vector4& vector) const
  3248. - Vector2 LocalToWorld2D(const Vector2& vector) const
  3249. - Vector3 WorldToLocal(const Vector3& position) const
  3250. - Vector3 WorldToLocal(const Vector4& vector) const
  3251. - Vector2 WorldToLocal2D(const Vector2& vector) const
  3252. - bool IsDirty() const
  3253. - unsigned GetNumChildren(bool recursive = false) const
  3254. - Node* GetChild(const String name, bool recursive = false) const
  3255. - Node* GetChild(StringHash nameHash, bool recursive = false) const
  3256. - Node* GetChild(unsigned index) const
  3257. - unsigned GetNumComponents() const
  3258. - unsigned GetNumNetworkComponents() const
  3259. - bool HasComponent(StringHash type) const
  3260. - bool HasComponent(const String type) const
  3261. - const Variant& GetVar(StringHash key) const
  3262. - const VariantMap& GetVars() const
  3263. - Component* GetComponent(const String type, bool recursive = false) const
  3264. - Component* GetParentComponent(const String type, bool recursive = false) const
  3265. - const PODVector<Component*>& GetComponents(const String type, bool recursive = false)
  3266. - const PODVector<Node*>& GetChildren(bool recursive = false)
  3267. - const PODVector<Node*>& GetChildrenWithComponent(const String type, bool recursive = false)
  3268. - bool Load(Deserializer& source, SceneResolver& resolver, bool loadChildren = true, bool rewriteIDs = false, CreateMode mode = REPLICATED)
  3269. - bool LoadXML(const XMLElement& source, SceneResolver& resolver, bool loadChildren = true, bool rewriteIDs = false, CreateMode mode = REPLICATED)
  3270. - bool LoadJSON(const JSONValue& source, SceneResolver& resolver, bool loadChildren = true, bool rewriteIDs = false, CreateMode mode = REPLICATED)
  3271. - Node* CreateChild(unsigned id, CreateMode mode)
  3272. - void AddComponent(Component* component, unsigned id, CreateMode mode)
  3273. Properties:
  3274. - unsigned ID (readonly)
  3275. - String name
  3276. - StringHash nameHash (readonly)
  3277. - Node* parent
  3278. - Scene* scene (readonly)
  3279. - bool enabled
  3280. - bool enabledSelf (readonly)
  3281. - Connection* owner
  3282. - Vector3& position
  3283. - Vector2 position2D
  3284. - Quaternion& rotation
  3285. - float rotation2D
  3286. - Vector3 direction
  3287. - Vector3 up (readonly)
  3288. - Vector3 right (readonly)
  3289. - Vector3& scale
  3290. - Vector2 scale2D
  3291. - Matrix3x4 transform (readonly)
  3292. - Vector3 worldPosition
  3293. - Vector2 worldPosition2D
  3294. - Quaternion worldRotation
  3295. - float worldRotation2D
  3296. - Vector3 worldDirection
  3297. - Vector3 worldUp (readonly)
  3298. - Vector3 worldRight (readonly)
  3299. - Vector3 worldScale
  3300. - Vector2 worldScale2D
  3301. - Matrix3x4& worldTransform (readonly)
  3302. - bool dirty (readonly)
  3303. - unsigned numComponents (readonly)
  3304. - unsigned numNetworkComponents (readonly)
  3305. <a name="Class_Object"></a>
  3306. ### Object : RefCounted
  3307. Methods:
  3308. - StringHash GetType() const
  3309. - const String GetTypeName() const
  3310. - const String GetCategory() const
  3311. - void SendEvent(const String eventName, VariantMap* eventData = 0)
  3312. - bool HasSubscribedToEvent(const String eventName) const
  3313. - bool HasSubscribedToEvent(Object* sender, const String eventName) const
  3314. Properties:
  3315. - StringHash type (readonly)
  3316. - const String typeName (readonly)
  3317. - const String category (readonly)
  3318. <a name="Class_ObjectAnimation"></a>
  3319. ### ObjectAnimation : Resource
  3320. Methods:
  3321. - ObjectAnimation() (GC)
  3322. - ObjectAnimation* new()
  3323. - void delete()
  3324. - void AddAttributeAnimation(const String name, ValueAnimation* attributeAnimation, WrapMode wrapMode = WM_LOOP, float speed = 1.0f)
  3325. - void RemoveAttributeAnimation(const String name)
  3326. - void RemoveAttributeAnimation(ValueAnimation* attributeAnimation)
  3327. - ValueAnimation* GetAttributeAnimation(const String name) const
  3328. - WrapMode GetAttributeAnimationWrapMode(const String name) const
  3329. - float GetAttributeAnimationSpeed(const String name) const
  3330. <a name="Class_Obstacle"></a>
  3331. ### Obstacle : Component
  3332. Methods:
  3333. - void DrawDebugGeometry(bool depthTest)
  3334. - void SetRadius(float radius)
  3335. - void SetHeight(float height)
  3336. - float GetRadius() const
  3337. - float GetHeight() const
  3338. Properties:
  3339. - float radius
  3340. - float height
  3341. <a name="Class_Octree"></a>
  3342. ### Octree : Component
  3343. Methods:
  3344. - void SetSize(const BoundingBox& box, unsigned numLevels)
  3345. - void Update(const FrameInfo& frame)
  3346. - void AddManualDrawable(Drawable* drawable)
  3347. - void RemoveManualDrawable(Drawable* drawable)
  3348. - const PODVector<OctreeQueryResult>& GetDrawables(const Vector3& point, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3349. - const PODVector<OctreeQueryResult>& GetDrawables(const BoundingBox& box, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3350. - const PODVector<OctreeQueryResult>& GetDrawables(const Frustum& frustum, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3351. - const PODVector<OctreeQueryResult>& GetDrawables(const Sphere& sphere, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3352. - const PODVector<OctreeQueryResult>& GetAllDrawables(char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3353. - const PODVector<RayQueryResult>& Raycast(const Ray& ray, RayQueryLevel level, float maxDistance, char drawableFlags, unsigned viewMask = DEFAULT_VIEWMASK) const
  3354. - RayQueryResult RaycastSingle(const Ray& ray, RayQueryLevel level, float maxDistance, char drawableFlags, unsigned viewMask = DEFAULT_VIEWMASK) const
  3355. - unsigned GetNumLevels() const
  3356. - void QueueUpdate(Drawable* drawable)
  3357. - void DrawDebugGeometry(bool depthTest)
  3358. Properties:
  3359. - unsigned numLevels (readonly)
  3360. <a name="Class_OctreeQueryResult"></a>
  3361. ### OctreeQueryResult
  3362. Methods:
  3363. - OctreeQueryResult() (GC)
  3364. - OctreeQueryResult* new()
  3365. - void delete()
  3366. Properties:
  3367. - Drawable* drawable
  3368. - Node* node
  3369. <a name="Class_OffMeshConnection"></a>
  3370. ### OffMeshConnection : Component
  3371. Methods:
  3372. - void SetEndPoint(Node* node)
  3373. - void SetRadius(float radius)
  3374. - void SetBidirectional(bool enabled)
  3375. - void SetMask(unsigned newMask)
  3376. - void SetAreaID(unsigned newAreaID)
  3377. - Node* GetEndPoint() const
  3378. - float GetRadius() const
  3379. - bool IsBidirectional() const
  3380. - unsigned GetMask() const
  3381. - unsigned GetAreaID() const
  3382. Properties:
  3383. - Node* endPoint
  3384. - float radius
  3385. - bool bidirectional
  3386. - unsigned mask
  3387. - unsigned areaID
  3388. <a name="Class_PackageEntry"></a>
  3389. ### PackageEntry
  3390. Properties:
  3391. - unsigned offset
  3392. - unsigned size
  3393. - unsigned checksum
  3394. <a name="Class_PackageFile"></a>
  3395. ### PackageFile : Object
  3396. Methods:
  3397. - PackageFile() (GC)
  3398. - PackageFile* new()
  3399. - PackageFile(const String fileName, unsigned startOffset = 0) (GC)
  3400. - PackageFile* new(const String fileName, unsigned startOffset = 0)
  3401. - void delete()
  3402. - bool Open(const String fileName, unsigned startOffset = 0)
  3403. - bool Exists(const String fileName) const
  3404. - const PackageEntry* GetEntry(const String fileName) const
  3405. - const HashMap<String,PackageEntry>& GetEntries() const
  3406. - const String GetName() const
  3407. - StringHash GetNameHash() const
  3408. - unsigned GetNumFiles() const
  3409. - unsigned GetTotalSize() const
  3410. - unsigned GetChecksum() const
  3411. - bool IsCompressed() const
  3412. Properties:
  3413. - String name (readonly)
  3414. - StringHash nameHash (readonly)
  3415. - unsigned numFiles (readonly)
  3416. - unsigned totalSize (readonly)
  3417. - unsigned checksum (readonly)
  3418. - bool compressed (readonly)
  3419. <a name="Class_ParticleEffect"></a>
  3420. ### ParticleEffect : Resource
  3421. Methods:
  3422. - ParticleEffect() (GC)
  3423. - ParticleEffect* new()
  3424. - void delete()
  3425. - void SetMaterial(Material* material)
  3426. - void SetNumParticles(unsigned num)
  3427. - void SetUpdateInvisible(bool enable)
  3428. - void SetRelative(bool enable)
  3429. - void SetScaled(bool enable)
  3430. - void SetSorted(bool enable)
  3431. - void SetAnimationLodBias(float lodBias)
  3432. - void SetEmitterType(EmitterType type)
  3433. - void SetEmitterSize(const Vector3& size)
  3434. - void SetMinDirection(const Vector3& direction)
  3435. - void SetMaxDirection(const Vector3& direction)
  3436. - void SetConstantForce(const Vector3& force)
  3437. - void SetDampingForce(float force)
  3438. - void SetActiveTime(float time)
  3439. - void SetInactiveTime(float time)
  3440. - void SetMinEmissionRate(float rate)
  3441. - void SetMaxEmissionRate(float rate)
  3442. - void SetMinParticleSize(const Vector2& size)
  3443. - void SetMaxParticleSize(const Vector2& size)
  3444. - void SetMinTimeToLive(float time)
  3445. - void SetMaxTimeToLive(float time)
  3446. - void SetMinVelocity(float velocity)
  3447. - void SetMaxVelocity(float velocity)
  3448. - void SetMinRotation(float rotation)
  3449. - void SetMaxRotation(float rotation)
  3450. - void SetMinRotationSpeed(float speed)
  3451. - void SetMaxRotationSpeed(float speed)
  3452. - void SetSizeAdd(float sizeAdd)
  3453. - void SetSizeMul(float sizeMul)
  3454. - void AddColorTime(const Color& color, const float time)
  3455. - void AddColorFrame(const ColorFrame& colorFrame)
  3456. - void RemoveColorFrame(unsigned index)
  3457. - void SetColorFrame(unsigned index, const ColorFrame& colorFrame)
  3458. - void SetNumColorFrames(unsigned number)
  3459. - void SortColorFrames()
  3460. - void AddTextureTime(const Rect& uv, const float time)
  3461. - void AddTextureFrame(const TextureFrame& textureFrame)
  3462. - void RemoveTextureFrame(unsigned index)
  3463. - void SetTextureFrame(unsigned index, const TextureFrame& textureFrame)
  3464. - void SetNumTextureFrames(unsigned number)
  3465. - void SortTextureFrames()
  3466. - Material* GetMaterial() const
  3467. - unsigned GetNumParticles() const
  3468. - bool GetUpdateInvisible() const
  3469. - bool IsRelative() const
  3470. - bool IsScaled() const
  3471. - bool IsSorted() const
  3472. - float GetAnimationLodBias() const
  3473. - EmitterType GetEmitterType() const
  3474. - const Vector3& GetEmitterSize() const
  3475. - const Vector3& GetMinDirection() const
  3476. - const Vector3& GetMaxDirection() const
  3477. - const Vector3& GetConstantForce() const
  3478. - float GetDampingForce() const
  3479. - float GetActiveTime() const
  3480. - float GetInactiveTime() const
  3481. - float GetMinEmissionRate() const
  3482. - float GetMaxEmissionRate() const
  3483. - const Vector2& GetMinParticleSize() const
  3484. - const Vector2& GetMaxParticleSize() const
  3485. - float GetMinTimeToLive() const
  3486. - float GetMaxTimeToLive() const
  3487. - float GetMinVelocity() const
  3488. - float GetMaxVelocity() const
  3489. - float GetMinRotation() const
  3490. - float GetMaxRotation() const
  3491. - float GetMinRotationSpeed() const
  3492. - float GetMaxRotationSpeed() const
  3493. - float GetSizeAdd() const
  3494. - float GetSizeMul() const
  3495. - unsigned GetNumColorFrames() const
  3496. - const ColorFrame* GetColorFrame(unsigned index) const
  3497. - unsigned GetNumTextureFrames() const
  3498. - const TextureFrame* GetTextureFrame(unsigned index) const
  3499. Properties:
  3500. - Material* material
  3501. - unsigned numParticles
  3502. - bool updateInvisible
  3503. - bool relative
  3504. - bool scaled
  3505. - bool sorted
  3506. - float animationLodBias
  3507. - EmitterType emitterType
  3508. - const Vector3& emitterSize
  3509. - const Vector3& minDirection
  3510. - const Vector3& maxDirection
  3511. - const Vector3& constantForce
  3512. - float dampingForce
  3513. - float activeTime
  3514. - float inactiveTime
  3515. - float minEmissionRate
  3516. - float maxEmissionRate
  3517. - const Vector2& minParticleSize
  3518. - const Vector2& maxParticleSize
  3519. - float minTimeToLive
  3520. - float maxTimeToLive
  3521. - float minVelocity
  3522. - float maxVelocity
  3523. - float minRotation
  3524. - float maxRotation
  3525. - float minRotationSpeed
  3526. - float maxRotationSpeed
  3527. - float sizeAdd
  3528. - float sizeMul
  3529. - unsigned numColorFrames
  3530. - unsigned numTextureFrames
  3531. <a name="Class_ParticleEffect2D"></a>
  3532. ### ParticleEffect2D : Resource
  3533. <a name="Class_ParticleEmitter"></a>
  3534. ### ParticleEmitter : BillboardSet
  3535. Methods:
  3536. - void SetEffect(ParticleEffect* effect)
  3537. - void SetNumParticles(unsigned num)
  3538. - void SetEmitting(bool enable)
  3539. - void SetSerializeParticles(bool enable)
  3540. - void ResetEmissionTimer()
  3541. - void RemoveAllParticles()
  3542. - void Reset()
  3543. - void ApplyEffect()
  3544. - ParticleEffect* GetEffect() const
  3545. - unsigned GetNumParticles() const
  3546. - bool IsEmitting() const
  3547. - bool GetSerializeParticles() const
  3548. Properties:
  3549. - ParticleEffect* effect
  3550. - unsigned numParticles
  3551. - bool emitting
  3552. - bool serializeParticles
  3553. <a name="Class_ParticleEmitter2D"></a>
  3554. ### ParticleEmitter2D : Drawable2D
  3555. Methods:
  3556. - void SetEffect(ParticleEffect2D* effect)
  3557. - void SetSprite(Sprite2D* sprite)
  3558. - void SetBlendMode(BlendMode blendMode)
  3559. - ParticleEffect2D* GetEffect() const
  3560. - Sprite2D* GetSprite() const
  3561. - BlendMode GetBlendMode() const
  3562. Properties:
  3563. - ParticleEffect2D* effect
  3564. - Sprite2D* sprite
  3565. - BlendMode blendMode
  3566. <a name="Class_Pass"></a>
  3567. ### Pass : RefCounted
  3568. Methods:
  3569. - bool IsDesktop() const
  3570. - const String GetVertexShader() const
  3571. - const String GetPixelShader() const
  3572. Properties:
  3573. - bool desktop (readonly)
  3574. - const String vertexShader (readonly)
  3575. - const String pixelShader (readonly)
  3576. <a name="Class_PhysicsRaycastResult"></a>
  3577. ### PhysicsRaycastResult
  3578. Methods:
  3579. - PhysicsRaycastResult() (GC)
  3580. - PhysicsRaycastResult* new()
  3581. - void delete()
  3582. Properties:
  3583. - Vector3 position
  3584. - Vector3 normal
  3585. - float distance
  3586. - float hitFraction
  3587. - RigidBody* body
  3588. <a name="Class_PhysicsRaycastResult2D"></a>
  3589. ### PhysicsRaycastResult2D
  3590. Methods:
  3591. - PhysicsRaycastResult2D() (GC)
  3592. - PhysicsRaycastResult2D* new()
  3593. - void delete()
  3594. Properties:
  3595. - Vector2 position
  3596. - Vector2 normal
  3597. - float distance
  3598. - RigidBody2D* body
  3599. <a name="Class_PhysicsWorld"></a>
  3600. ### PhysicsWorld : Component
  3601. Methods:
  3602. - void Update(float timeStep)
  3603. - void UpdateCollisions()
  3604. - void SetFps(int fps)
  3605. - void SetGravity(const Vector3& gravity)
  3606. - void SetMaxSubSteps(int num)
  3607. - void SetNumIterations(int num)
  3608. - void SetUpdateEnabled(bool enable)
  3609. - void SetInterpolation(bool enable)
  3610. - void SetInternalEdge(bool enable)
  3611. - void SetSplitImpulse(bool enable)
  3612. - void SetMaxNetworkAngularVelocity(float velocity)
  3613. - const PODVector<PhysicsRaycastResult>& Raycast(const Ray& ray, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  3614. - PhysicsRaycastResult RaycastSingle(const Ray& ray, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  3615. - PhysicsRaycastResult RaycastSingleSegmented(const Ray& ray, float maxDistance, float segmentDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  3616. - PhysicsRaycastResult SphereCast(const Ray& ray, float radius, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  3617. - PhysicsRaycastResult ConvexCast(CollisionShape* shape, const Vector3& startPos, const Quaternion& startRot, const Vector3& endPos, const Quaternion& endRot, unsigned collisionMask = M_MAX_UNSIGNED)
  3618. - const PODVector<RigidBody*>& GetRigidBodies(const Sphere& sphere, unsigned collisionMask = M_MAX_UNSIGNED)
  3619. - const PODVector<RigidBody*>& GetRigidBodies(const BoundingBox& box, unsigned collisionMask = M_MAX_UNSIGNED)
  3620. - const PODVector<RigidBody*>& GetRigidBodies(const RigidBody* body)
  3621. - const PODVector<RigidBody*>& GetCollidingBodies(const RigidBody* body)
  3622. - void DrawDebugGeometry(bool depthTest)
  3623. - void RemoveCachedGeometry(Model* model)
  3624. - Vector3 GetGravity() const
  3625. - int GetMaxSubSteps() const
  3626. - int GetNumIterations() const
  3627. - bool IsUpdateEnabled() const
  3628. - bool GetInterpolation() const
  3629. - bool GetInternalEdge() const
  3630. - bool GetSplitImpulse() const
  3631. - int GetFps() const
  3632. - float GetMaxNetworkAngularVelocity() const
  3633. Properties:
  3634. - Vector3 gravity
  3635. - int maxSubSteps
  3636. - int numIterations
  3637. - bool updateEnabled
  3638. - bool interpolation
  3639. - bool internalEdge
  3640. - bool splitImpulse
  3641. - int fps
  3642. - float maxNetworkAngularVelocity
  3643. <a name="Class_PhysicsWorld2D"></a>
  3644. ### PhysicsWorld2D : Component
  3645. Methods:
  3646. - void DrawDebugGeometry()
  3647. - void SetUpdateEnabled(bool enable)
  3648. - void SetDrawShape(bool drawShape)
  3649. - void SetDrawJoint(bool drawJoint)
  3650. - void SetDrawAabb(bool drawAabb)
  3651. - void SetDrawPair(bool drawPair)
  3652. - void SetDrawCenterOfMass(bool drawCenterOfMass)
  3653. - void SetAllowSleeping(bool enable)
  3654. - void SetWarmStarting(bool enable)
  3655. - void SetContinuousPhysics(bool enable)
  3656. - void SetSubStepping(bool enable)
  3657. - void SetGravity(const Vector2& gravity)
  3658. - void SetAutoClearForces(bool enable)
  3659. - void SetVelocityIterations(int velocityIterations)
  3660. - void SetPositionIterations(int positionIterations)
  3661. - const PODVector<PhysicsRaycastResult2D>& Raycast(const Vector2& startPoint, const Vector2& endPoint, unsigned collisionMask = M_MAX_UNSIGNED)
  3662. - PhysicsRaycastResult2D RaycastSingle(const Vector2& startPoint, const Vector2& endPoint, unsigned collisionMask = M_MAX_UNSIGNED)
  3663. - RigidBody2D* GetRigidBody(const Vector2& point, unsigned collisionMask = M_MAX_UNSIGNED)
  3664. - RigidBody2D* GetRigidBody(int screenX, int screenY, unsigned collisionMask = M_MAX_UNSIGNED)
  3665. - const PODVector<RigidBody2D*>& GetRigidBodies(const Rect& aabb, unsigned collisionMask = M_MAX_UNSIGNED)
  3666. - bool IsUpdateEnabled() const
  3667. - bool GetDrawShape() const
  3668. - bool GetDrawJoint() const
  3669. - bool GetDrawAabb() const
  3670. - bool GetDrawPair() const
  3671. - bool GetDrawCenterOfMass() const
  3672. - bool GetAllowSleeping() const
  3673. - bool GetWarmStarting() const
  3674. - bool GetContinuousPhysics() const
  3675. - bool GetSubStepping() const
  3676. - bool GetAutoClearForces() const
  3677. - const Vector2& GetGravity() const
  3678. - int GetVelocityIterations() const
  3679. - int GetPositionIterations() const
  3680. Properties:
  3681. - bool updateEnabled
  3682. - bool drawShape
  3683. - bool drawJoint
  3684. - bool drawAabb
  3685. - bool drawPair
  3686. - bool drawCenterOfMass
  3687. - bool allowSleeping
  3688. - bool warmStarting
  3689. - bool continuousPhysics
  3690. - bool subStepping
  3691. - bool autoClearForces
  3692. - Vector2& gravity
  3693. - int velocityIterations
  3694. - int positionIterations
  3695. <a name="Class_Plane"></a>
  3696. ### Plane
  3697. Methods:
  3698. - Plane() (GC)
  3699. - Plane* new()
  3700. - Plane(const Plane& plane) (GC)
  3701. - Plane* new(const Plane& plane)
  3702. - Plane(const Vector3& v0, const Vector3& v1, const Vector3& v2) (GC)
  3703. - Plane* new(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  3704. - Plane(const Vector3& normal, const Vector3& point) (GC)
  3705. - Plane* new(const Vector3& normal, const Vector3& point)
  3706. - Plane(const Vector4& plane) (GC)
  3707. - Plane* new(const Vector4& plane)
  3708. - void delete()
  3709. - void Define(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  3710. - void Define(const Vector3& normal, const Vector3& point)
  3711. - void Define(const Vector4& plane)
  3712. - void Transform(const Matrix3& transform)
  3713. - void Transform(const Matrix3x4& transform)
  3714. - void Transform(const Matrix4& transform)
  3715. - Vector3 Project(const Vector3& point) const
  3716. - float Distance(const Vector3& point) const
  3717. - Vector3 Reflect(const Vector3& direction) const
  3718. - Matrix3x4 ReflectionMatrix() const
  3719. - Plane Transformed(const Matrix3& transform) const
  3720. - Plane Transformed(const Matrix3x4& transform) const
  3721. - Plane Transformed(const Matrix4& transform) const
  3722. - Vector4 ToVector4() const
  3723. Properties:
  3724. - Vector3 normal
  3725. - Vector3 absNormal
  3726. - float d
  3727. - const Plane UP
  3728. <a name="Class_Polyhedron"></a>
  3729. ### Polyhedron
  3730. Methods:
  3731. - Polyhedron() (GC)
  3732. - Polyhedron* new()
  3733. - Polyhedron(const Polyhedron& polyhedron) (GC)
  3734. - Polyhedron* new(const Polyhedron& polyhedron)
  3735. - Polyhedron(const BoundingBox& box) (GC)
  3736. - Polyhedron* new(const BoundingBox& box)
  3737. - Polyhedron(const Frustum& frustum) (GC)
  3738. - Polyhedron* new(const Frustum& frustum)
  3739. - void delete()
  3740. - void Define(const BoundingBox& box)
  3741. - void Define(const Frustum& frustum)
  3742. - void AddFace(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  3743. - void AddFace(const Vector3& v0, const Vector3& v1, const Vector3& v2, const Vector3& v3)
  3744. - void Clip(const Plane& plane)
  3745. - void Clip(const BoundingBox& box)
  3746. - void Clip(const Frustum& box)
  3747. - void Clear()
  3748. - void Transform(const Matrix3& transform)
  3749. - void Transform(const Matrix3x4& transform)
  3750. - Polyhedron Transformed(const Matrix3& transform) const
  3751. - Polyhedron Transformed(const Matrix3x4& transform) const
  3752. - bool Empty() const
  3753. Properties:
  3754. - bool empty (readonly)
  3755. <a name="Class_PropertySet2D"></a>
  3756. ### PropertySet2D
  3757. Methods:
  3758. - bool HasProperty(const String name) const
  3759. - const String GetProperty(const String name) const
  3760. <a name="Class_Quaternion"></a>
  3761. ### Quaternion
  3762. Methods:
  3763. - Quaternion() (GC)
  3764. - Quaternion* new()
  3765. - Quaternion(const Quaternion& quat) (GC)
  3766. - Quaternion* new(const Quaternion& quat)
  3767. - Quaternion(float w, float x, float y, float z) (GC)
  3768. - Quaternion* new(float w, float x, float y, float z)
  3769. - Quaternion(float angle, const Vector3& axis) (GC)
  3770. - Quaternion* new(float angle, const Vector3& axis)
  3771. - Quaternion(float angle) (GC)
  3772. - Quaternion* new(float angle)
  3773. - Quaternion(float x, float y, float z) (GC)
  3774. - Quaternion* new(float x, float y, float z)
  3775. - Quaternion(const Vector3& start, const Vector3& end) (GC)
  3776. - Quaternion* new(const Vector3& start, const Vector3& end)
  3777. - Quaternion(const Vector3& xAxis, const Vector3& yAxis, const Vector3& zAxis) (GC)
  3778. - Quaternion* new(const Vector3& xAxis, const Vector3& yAxis, const Vector3& zAxis)
  3779. - Quaternion(const Matrix3& matrix) (GC)
  3780. - Quaternion* new(const Matrix3& matrix)
  3781. - void delete()
  3782. - bool operator==(const Quaternion& rhs) const
  3783. - Quaternion operator*(float rhs) const
  3784. - Quaternion operator-() const
  3785. - bool operator==(const Quaternion& rhs) const
  3786. - Quaternion operator*(float rhs) const
  3787. - Quaternion operator-() const
  3788. - Quaternion operator+(const Quaternion& rhs) const
  3789. - Quaternion operator-(const Quaternion& rhs) const
  3790. - Quaternion operator*(const Quaternion& rhs) const
  3791. - Vector3 operator*(const Vector3& rhs) const
  3792. - void FromAngleAxis(float angle, const Vector3& axis)
  3793. - void FromEulerAngles(float x, float y, float z)
  3794. - void FromRotationTo(const Vector3& start, const Vector3& end)
  3795. - void FromAxes(const Vector3& xAxis, const Vector3& yAxis, const Vector3& zAxis)
  3796. - void FromRotationMatrix(const Matrix3& matrix)
  3797. - bool FromLookRotation(const Vector3& direction, const Vector3& up)
  3798. - void Normalize()
  3799. - Quaternion Normalized() const
  3800. - Quaternion Inverse() const
  3801. - float LengthSquared() const
  3802. - float DotProduct(const Quaternion& rhs) const
  3803. - bool Equals(const Quaternion& rhs) const
  3804. - bool IsNaN() const
  3805. - Quaternion Conjugate() const
  3806. - Vector3 EulerAngles() const
  3807. - float YawAngle() const
  3808. - float PitchAngle() const
  3809. - float RollAngle() const
  3810. - Matrix3 RotationMatrix() const
  3811. - Quaternion Slerp(Quaternion rhs, float t) const
  3812. - Quaternion Nlerp(Quaternion rhs, float t, bool shortestPath) const
  3813. - String ToString() const
  3814. Properties:
  3815. - float w
  3816. - float x
  3817. - float y
  3818. - float z
  3819. - const Quaternion IDENTITY
  3820. <a name="Class_Ray"></a>
  3821. ### Ray
  3822. Methods:
  3823. - Ray() (GC)
  3824. - Ray* new()
  3825. - Ray(const Vector3& origin, const Vector3& direction) (GC)
  3826. - Ray* new(const Vector3& origin, const Vector3& direction)
  3827. - Ray(const Ray& ray) (GC)
  3828. - Ray* new(const Ray& ray)
  3829. - void delete()
  3830. - bool operator==(const Ray& rhs) const
  3831. - void Define(const Vector3& origin, const Vector3& direction)
  3832. - Vector3 Project(const Vector3& point) const
  3833. - float Distance(const Vector3& point) const
  3834. - Vector3 ClosestPoint(const Ray& ray) const
  3835. - float HitDistance(const Plane& plane) const
  3836. - float HitDistance(const BoundingBox& box) const
  3837. - float HitDistance(const Frustum& frustum, bool solidInside = true) const
  3838. - float HitDistance(const Sphere& sphere) const
  3839. - float HitDistance(const Vector3& v0, const Vector3& v1, const Vector3& v2) const
  3840. - Ray Transformed(const Matrix3x4& transform) const
  3841. Properties:
  3842. - Vector3 origin
  3843. - Vector3 direction
  3844. <a name="Class_RayQueryResult"></a>
  3845. ### RayQueryResult
  3846. Methods:
  3847. - RayQueryResult() (GC)
  3848. - RayQueryResult* new()
  3849. - void delete()
  3850. Properties:
  3851. - Vector3 position
  3852. - Vector3 normal
  3853. - Vector2 textureUV
  3854. - float distance
  3855. - Drawable* drawable
  3856. - Node* node
  3857. - unsigned subObject
  3858. <a name="Class_Rect"></a>
  3859. ### Rect
  3860. Methods:
  3861. - Rect() (GC)
  3862. - Rect* new()
  3863. - Rect(const Rect& rect) (GC)
  3864. - Rect* new(const Rect& rect)
  3865. - Rect(const Vector2& min, const Vector2& max) (GC)
  3866. - Rect* new(const Vector2& min, const Vector2& max)
  3867. - Rect(float left, float top, float right, float bottom) (GC)
  3868. - Rect* new(float left, float top, float right, float bottom)
  3869. - Rect(const Vector4& vector) (GC)
  3870. - Rect* new(const Vector4& vector)
  3871. - void delete()
  3872. - bool operator==(const Rect& rhs) const
  3873. - void Define(const Rect& rect)
  3874. - void Define(const Vector2& min, const Vector2& max)
  3875. - void Define(const Vector2& point)
  3876. - void Merge(const Vector2& point)
  3877. - void Merge(const Rect& rect)
  3878. - void Clear()
  3879. - void Clip(const Rect& rect)
  3880. - bool Defined() const
  3881. - Vector2 Center() const
  3882. - Vector2 Size() const
  3883. - Vector2 HalfSize() const
  3884. - bool Equals(const Rect& rhs) const
  3885. - Intersection IsInside(const Vector2& point) const
  3886. - Vector4 ToVector4() const
  3887. - String ToString() const
  3888. Properties:
  3889. - Vector2 min
  3890. - Vector2 max
  3891. - const Rect FULL
  3892. - const Rect POSITIVE
  3893. - const Rect ZERO
  3894. - Vector2 center (readonly)
  3895. - Vector2 size (readonly)
  3896. - Vector2 halfSize (readonly)
  3897. <a name="Class_RemoteEvent"></a>
  3898. ### RemoteEvent
  3899. Properties:
  3900. - unsigned senderID
  3901. - StringHash eventType
  3902. - VariantMap eventData
  3903. - bool inOrder
  3904. <a name="Class_RenderPath"></a>
  3905. ### RenderPath
  3906. Methods:
  3907. - RenderPath* Clone()
  3908. - bool Load(XMLFile* file)
  3909. - bool Append(XMLFile* file)
  3910. - void SetEnabled(const String tag, bool active)
  3911. - void ToggleEnabled(const String tag)
  3912. - void SetRenderTarget(unsigned index, const RenderTargetInfo& info)
  3913. - void AddRenderTarget(const RenderTargetInfo& info)
  3914. - void RemoveRenderTarget(const String name)
  3915. - void RemoveRenderTarget(unsigned index)
  3916. - void RemoveRenderTargets(const String tag)
  3917. - void SetCommand(unsigned index, const RenderPathCommand& command)
  3918. - void AddCommand(const RenderPathCommand& command)
  3919. - void InsertCommand(unsigned index, const RenderPathCommand& command)
  3920. - void RemoveCommand(unsigned index)
  3921. - void RemoveCommands(const String tag)
  3922. - void SetShaderParameter(const String name, const Variant& value)
  3923. - unsigned GetNumRenderTargets() const
  3924. - unsigned GetNumCommands() const
  3925. - RenderPathCommand* GetCommand(unsigned index)
  3926. - const Variant& GetShaderParameter(const String name) const
  3927. <a name="Class_RenderPathCommand"></a>
  3928. ### RenderPathCommand
  3929. Methods:
  3930. - RenderPathCommand() (GC)
  3931. - RenderPathCommand* new()
  3932. - void Load(const XMLElement& element)
  3933. - void SetTextureName(TextureUnit unit, const String name)
  3934. - void SetShaderParameter(const String name, const Variant& value)
  3935. - void RemoveShaderParameter(const String name)
  3936. - void SetNumOutputs(unsigned num)
  3937. - void SetOutput(unsigned index, const String name, CubeMapFace face)
  3938. - void SetOutputName(unsigned index, const String name)
  3939. - void SetOutputFace(unsigned index, CubeMapFace face)
  3940. - void SetDepthStencilName(const String name)
  3941. - const String GetTextureName(TextureUnit unit) const
  3942. - const Variant& GetShaderParameter(const String name) const
  3943. - unsigned GetNumOutputs() const
  3944. - const String GetOutputName(unsigned index) const
  3945. - CubeMapFace GetOutputFace(unsigned index) const
  3946. - const String GetDepthStencilName() const
  3947. Properties:
  3948. - String tag
  3949. - RenderCommandType type
  3950. - RenderCommandSortMode sortMode
  3951. - String pass
  3952. - String metadata
  3953. - String vertexShaderName
  3954. - String pixelShaderName
  3955. - String vertexShaderDefines
  3956. - String pixelShaderDefines
  3957. - unsigned clearFlags
  3958. - Color clearColor
  3959. - float clearDepth
  3960. - unsigned clearStencil
  3961. - BlendMode blendMode
  3962. - bool enabled
  3963. - bool useFogColor
  3964. - bool markToStencil
  3965. - bool useLitBase
  3966. - bool vertexLights
  3967. <a name="Class_RenderSurface"></a>
  3968. ### RenderSurface
  3969. Methods:
  3970. - RenderSurface(Texture* parentTexture) (GC)
  3971. - RenderSurface* new(Texture* parentTexture)
  3972. - void delete()
  3973. - void SetNumViewports(unsigned num)
  3974. - void SetViewport(unsigned index, Viewport* viewport)
  3975. - void SetUpdateMode(RenderSurfaceUpdateMode mode)
  3976. - void SetLinkedRenderTarget(RenderSurface* renderTarget)
  3977. - void SetLinkedDepthStencil(RenderSurface* depthStencil)
  3978. - void QueueUpdate()
  3979. - void Release()
  3980. - Texture* GetParentTexture() const
  3981. - int GetWidth() const
  3982. - int GetHeight() const
  3983. - TextureUsage GetUsage() const
  3984. - unsigned GetNumViewports() const
  3985. - Viewport* GetViewport(unsigned index) const
  3986. - RenderSurfaceUpdateMode GetUpdateMode() const
  3987. - RenderSurface* GetLinkedRenderTarget() const
  3988. - RenderSurface* GetLinkedDepthStencil() const
  3989. Properties:
  3990. - Texture* parentTexture (readonly)
  3991. - int width (readonly)
  3992. - int height (readonly)
  3993. - TextureUsage usage (readonly)
  3994. - unsigned numViewports
  3995. - RenderSurfaceUpdateMode updateMode
  3996. - RenderSurface* linkedRenderTarget
  3997. - RenderSurface* linkedDepthStencil
  3998. <a name="Class_RenderTargetInfo"></a>
  3999. ### RenderTargetInfo
  4000. Methods:
  4001. - RenderTargetInfo() (GC)
  4002. - RenderTargetInfo* new()
  4003. - void Load(const XMLElement& element)
  4004. Properties:
  4005. - String name
  4006. - String tag
  4007. - unsigned format
  4008. - Vector2 size
  4009. - RenderTargetSizeMode sizeMode
  4010. - bool enabled
  4011. - bool cubemap
  4012. - bool filtered
  4013. - bool sRGB
  4014. - bool persistent
  4015. <a name="Class_Renderer"></a>
  4016. ### Renderer
  4017. Methods:
  4018. - void SetNumViewports(unsigned num)
  4019. - void SetViewport(unsigned index, Viewport* viewport)
  4020. - void SetDefaultRenderPath(RenderPath* renderPath)
  4021. - void SetDefaultRenderPath(XMLFile* file)
  4022. - void SetHDRRendering(bool enable)
  4023. - void SetSpecularLighting(bool enable)
  4024. - void SetTextureAnisotropy(int level)
  4025. - void SetTextureFilterMode(TextureFilterMode mode)
  4026. - void SetTextureQuality(int quality)
  4027. - void SetMaterialQuality(int quality)
  4028. - void SetDrawShadows(bool enable)
  4029. - void SetShadowMapSize(int size)
  4030. - void SetShadowQuality(ShadowQuality quality)
  4031. - void SetShadowSoftness(float shadowSoftness)
  4032. - void SetVSMShadowParameters(float minVariance, float lightBleedingReduction)
  4033. - void SetReuseShadowMaps(bool enable)
  4034. - void SetMaxShadowMaps(int shadowMaps)
  4035. - void SetDynamicInstancing(bool enable)
  4036. - void SetMinInstances(int instances)
  4037. - void SetMaxSortedInstances(int instances)
  4038. - void SetMaxOccluderTriangles(int triangles)
  4039. - void SetOcclusionBufferSize(int size)
  4040. - void SetOccluderSizeThreshold(float screenSize)
  4041. - void SetThreadedOcclusion(bool enable)
  4042. - void SetMobileShadowBiasMul(float mul)
  4043. - void SetMobileShadowBiasAdd(float add)
  4044. - void ReloadShaders()
  4045. - unsigned GetNumViewports() const
  4046. - Viewport* GetViewport(unsigned index) const
  4047. - RenderPath* GetDefaultRenderPath() const
  4048. - bool GetHDRRendering() const
  4049. - bool GetSpecularLighting() const
  4050. - bool GetDrawShadows() const
  4051. - int GetTextureAnisotropy() const
  4052. - TextureFilterMode GetTextureFilterMode() const
  4053. - int GetTextureQuality() const
  4054. - int GetMaterialQuality() const
  4055. - int GetShadowMapSize() const
  4056. - ShadowQuality GetShadowQuality() const
  4057. - float GetShadowSoftness() const
  4058. - Vector2 GetVSMShadowParameters() const
  4059. - bool GetReuseShadowMaps() const
  4060. - int GetMaxShadowMaps() const
  4061. - bool GetDynamicInstancing() const
  4062. - int GetMinInstances() const
  4063. - int GetMaxSortedInstances() const
  4064. - int GetMaxOccluderTriangles() const
  4065. - int GetOcclusionBufferSize() const
  4066. - float GetOccluderSizeThreshold() const
  4067. - bool GetThreadedOcclusion() const
  4068. - float GetMobileShadowBiasMul() const
  4069. - float GetMobileShadowBiasAdd() const
  4070. - unsigned GetNumViews() const
  4071. - unsigned GetNumPrimitives() const
  4072. - unsigned GetNumBatches() const
  4073. - unsigned GetNumGeometries(bool allViews = false) const
  4074. - unsigned GetNumLights(bool allViews = false) const
  4075. - unsigned GetNumShadowMaps(bool allViews = false) const
  4076. - unsigned GetNumOccluders(bool allViews = false) const
  4077. - Zone* GetDefaultZone() const
  4078. - Material* GetDefaultMaterial() const
  4079. - Texture2D* GetDefaultLightRamp() const
  4080. - Texture2D* GetDefaultLightSpot() const
  4081. - void DrawDebugGeometry(bool depthTest)
  4082. Properties:
  4083. - unsigned numViewports
  4084. - RenderPath* defaultRenderPath
  4085. - bool HDRRendering
  4086. - bool specularLighting
  4087. - bool drawShadows
  4088. - int textureAnisotropy
  4089. - TextureFilterMode textureFilterMode
  4090. - int textureQuality
  4091. - int materialQuality
  4092. - int shadowMapSize
  4093. - ShadowQuality shadowQuality
  4094. - float shadowSoftness
  4095. - bool reuseShadowMaps
  4096. - int maxShadowMaps
  4097. - bool dynamicInstancing
  4098. - int minInstances
  4099. - int maxSortedInstances
  4100. - int maxOccluderTriangles
  4101. - int occlusionBufferSize
  4102. - float occluderSizeThreshold
  4103. - bool threadedOcclusion
  4104. - float mobileShadowBiasMul
  4105. - float mobileShadowBiasAdd
  4106. - unsigned numViews (readonly)
  4107. - unsigned numPrimitives (readonly)
  4108. - unsigned numBatches (readonly)
  4109. - Zone* defaultZone (readonly)
  4110. - Material* defaultMaterial (readonly)
  4111. - Texture2D* defaultLightRamp (readonly)
  4112. - Texture2D* defaultLightSpot (readonly)
  4113. <a name="Class_Resource"></a>
  4114. ### Resource
  4115. Methods:
  4116. - bool Load(Deserializer& source)
  4117. - bool Save(Serializer& dest) const
  4118. - bool Load(const String fileName)
  4119. - bool Save(const String fileName) const
  4120. - const String GetName() const
  4121. - StringHash GetNameHash() const
  4122. - unsigned GetMemoryUse() const
  4123. Properties:
  4124. - String name (readonly)
  4125. - StringHash nameHash (readonly)
  4126. - unsigned memoryUse (readonly)
  4127. <a name="Class_ResourceCache"></a>
  4128. ### ResourceCache
  4129. Methods:
  4130. - void ReleaseAllResources(bool force = false)
  4131. - bool ReloadResource(Resource* resource)
  4132. - void ReloadResourceWithDependencies(const String fileName)
  4133. - void SetMemoryBudget(StringHash type, long budget)
  4134. - void SetMemoryBudget(const String type, long budget)
  4135. - void SetAutoReloadResources(bool enable)
  4136. - void SetReturnFailedResources(bool enable)
  4137. - void SetSearchPackagesFirst(bool value)
  4138. - void SetFinishBackgroundResourcesMs(int ms)
  4139. - File* GetFile(const String name)
  4140. - Resource* GetResource(const String type, const String name, bool sendEventOnFailure = true)
  4141. - Resource* GetExistingResource(const String type, const String name)
  4142. - bool BackgroundLoadResource(const String type, const String name, bool sendEventOnFailure = true)
  4143. - unsigned GetNumBackgroundLoadResources() const
  4144. - const Vector<String>& GetResourceDirs() const
  4145. - bool Exists(const String name) const
  4146. - long GetMemoryBudget(StringHash type) const
  4147. - long GetMemoryUse(StringHash type) const
  4148. - long GetTotalMemoryUse() const
  4149. - String GetResourceFileName(const String name) const
  4150. - bool GetAutoReloadResources() const
  4151. - bool GetReturnFailedResources() const
  4152. - bool GetSearchPackagesFirst() const
  4153. - int GetFinishBackgroundResourcesMs() const
  4154. - String GetPreferredResourceDir(const String path) const
  4155. - String SanitateResourceName(const String name) const
  4156. - String SanitateResourceDirName(const String name) const
  4157. Properties:
  4158. - long totalMemoryUse (readonly)
  4159. - bool autoReloadResources
  4160. - bool returnFailedResources
  4161. - bool searchPackagesFirst
  4162. - unsigned numBackgroundLoadResources (readonly)
  4163. - Vector<String>& resourceDirs (readonly)
  4164. - int finishBackgroundResourcesMs
  4165. <a name="Class_ResourceRef"></a>
  4166. ### ResourceRef
  4167. Methods:
  4168. - ResourceRef() (GC)
  4169. - ResourceRef* new()
  4170. - ResourceRef(StringHash type) (GC)
  4171. - ResourceRef* new(StringHash type)
  4172. - ResourceRef(StringHash type, String name) (GC)
  4173. - ResourceRef* new(StringHash type, String name)
  4174. - ResourceRef(const ResourceRef& rhs) (GC)
  4175. - ResourceRef* new(const ResourceRef& rhs)
  4176. - void delete()
  4177. - bool operator==(const ResourceRef& rhs) const
  4178. Properties:
  4179. - StringHash type
  4180. - String name
  4181. <a name="Class_ResourceRefList"></a>
  4182. ### ResourceRefList
  4183. Methods:
  4184. - ResourceRefList() (GC)
  4185. - ResourceRefList* new()
  4186. - ResourceRefList(StringHash type) (GC)
  4187. - ResourceRefList* new(StringHash type)
  4188. - void delete()
  4189. - bool operator==(const ResourceRefList& rhs) const
  4190. Properties:
  4191. - StringHash type
  4192. <a name="Class_RigidBody"></a>
  4193. ### RigidBody : Component
  4194. Methods:
  4195. - void SetMass(float mass)
  4196. - void SetPosition(const Vector3& position)
  4197. - void SetRotation(const Quaternion& rotation)
  4198. - void SetTransform(const Vector3& position, const Quaternion& rotation)
  4199. - void SetLinearVelocity(const Vector3& velocity)
  4200. - void SetLinearFactor(const Vector3& factor)
  4201. - void SetLinearRestThreshold(float threshold)
  4202. - void SetLinearDamping(float damping)
  4203. - void SetAngularVelocity(const Vector3& angularVelocity)
  4204. - void SetAngularFactor(const Vector3& factor)
  4205. - void SetAngularRestThreshold(float threshold)
  4206. - void SetAngularDamping(float factor)
  4207. - void SetFriction(float friction)
  4208. - void SetAnisotropicFriction(const Vector3& friction)
  4209. - void SetRollingFriction(float friction)
  4210. - void SetRestitution(float restitution)
  4211. - void SetContactProcessingThreshold(float threshold)
  4212. - void SetCcdRadius(float radius)
  4213. - void SetCcdMotionThreshold(float threshold)
  4214. - void SetUseGravity(bool enable)
  4215. - void SetGravityOverride(const Vector3& gravity)
  4216. - void SetKinematic(bool enable)
  4217. - void SetTrigger(bool enable)
  4218. - void SetCollisionLayer(unsigned layer)
  4219. - void SetCollisionMask(unsigned mask)
  4220. - void SetCollisionLayerAndMask(unsigned layer, unsigned mask)
  4221. - void SetCollisionEventMode(CollisionEventMode mode)
  4222. - void DisableMassUpdate()
  4223. - void EnableMassUpdate()
  4224. - void ApplyForce(const Vector3& force)
  4225. - void ApplyForce(const Vector3& force, const Vector3& position)
  4226. - void ApplyTorque(const Vector3& torque)
  4227. - void ApplyImpulse(const Vector3& impulse)
  4228. - void ApplyImpulse(const Vector3& impulse, const Vector3& position)
  4229. - void ApplyTorqueImpulse(const Vector3& torque)
  4230. - void ResetForces()
  4231. - void Activate()
  4232. - void ReAddBodyToWorld()
  4233. - PhysicsWorld* GetPhysicsWorld() const
  4234. - float GetMass() const
  4235. - Vector3 GetPosition() const
  4236. - Quaternion GetRotation() const
  4237. - Vector3 GetLinearVelocity() const
  4238. - Vector3 GetLinearFactor() const
  4239. - Vector3 GetVelocityAtPoint(const Vector3& position) const
  4240. - float GetLinearRestThreshold() const
  4241. - float GetLinearDamping() const
  4242. - Vector3 GetAngularVelocity() const
  4243. - Vector3 GetAngularFactor() const
  4244. - float GetAngularRestThreshold() const
  4245. - float GetAngularDamping() const
  4246. - float GetFriction() const
  4247. - Vector3 GetAnisotropicFriction() const
  4248. - float GetRollingFriction() const
  4249. - float GetRestitution() const
  4250. - float GetContactProcessingThreshold() const
  4251. - float GetCcdRadius() const
  4252. - float GetCcdMotionThreshold() const
  4253. - bool GetUseGravity() const
  4254. - const Vector3& GetGravityOverride() const
  4255. - const Vector3& GetCenterOfMass() const
  4256. - bool IsKinematic() const
  4257. - bool IsTrigger() const
  4258. - bool IsActive() const
  4259. - unsigned GetCollisionLayer() const
  4260. - unsigned GetCollisionMask() const
  4261. - CollisionEventMode GetCollisionEventMode() const
  4262. Properties:
  4263. - PhysicsWorld* physicsWorld (readonly)
  4264. - float mass
  4265. - Vector3 position
  4266. - Quaternion rotation
  4267. - Vector3 linearVelocity
  4268. - Vector3 linearFactor
  4269. - float linearRestThreshold
  4270. - float linearDamping
  4271. - Vector3 angularVelocity
  4272. - Vector3 angularFactor
  4273. - float angularRestThreshold
  4274. - float angularDamping
  4275. - float friction
  4276. - Vector3 anisotropicFriction
  4277. - float rollingFriction
  4278. - float restitution
  4279. - float contactProcessingThreshold
  4280. - float ccdRadius
  4281. - float ccdMotionThreshold
  4282. - bool useGravity
  4283. - Vector3& gravityOverride
  4284. - Vector3& centerOfMass (readonly)
  4285. - bool kinematic
  4286. - bool trigger
  4287. - bool active (readonly)
  4288. - unsigned collisionLayer
  4289. - unsigned collisionMask
  4290. - CollisionEventMode collisionEventMode
  4291. <a name="Class_RigidBody2D"></a>
  4292. ### RigidBody2D : Component
  4293. Methods:
  4294. - void SetBodyType(BodyType2D bodyType)
  4295. - void SetMass(float mass)
  4296. - void SetInertia(float inertia)
  4297. - void SetMassCenter(const Vector2& center)
  4298. - void SetUseFixtureMass(bool useFixtureMass)
  4299. - void SetLinearDamping(float linearDamping)
  4300. - void SetAngularDamping(float angularDamping)
  4301. - void SetAllowSleep(bool allowSleep)
  4302. - void SetFixedRotation(bool fixedRotation)
  4303. - void SetBullet(bool bullet)
  4304. - void SetGravityScale(float gravityScale)
  4305. - void SetAwake(bool awake)
  4306. - void SetLinearVelocity(const Vector2& linearVelocity)
  4307. - void SetAngularVelocity(float angularVelocity)
  4308. - void ApplyForce(const Vector2& force, const Vector2& point, bool wake)
  4309. - void ApplyForceToCenter(const Vector2& force, bool wake)
  4310. - void ApplyTorque(float torque, bool wake)
  4311. - void ApplyLinearImpulse(const Vector2& impulse, const Vector2& point, bool wake)
  4312. - void ApplyAngularImpulse(float impulse, bool wake)
  4313. - BodyType2D GetBodyType() const
  4314. - float GetMass() const
  4315. - float GetInertia() const
  4316. - Vector2 GetMassCenter() const
  4317. - bool GetUseFixtureMass() const
  4318. - float GetLinearDamping() const
  4319. - float GetAngularDamping() const
  4320. - bool IsAllowSleep() const
  4321. - bool IsFixedRotation() const
  4322. - bool IsBullet() const
  4323. - float GetGravityScale() const
  4324. - bool IsAwake() const
  4325. - Vector2 GetLinearVelocity() const
  4326. - float GetAngularVelocity() const
  4327. Properties:
  4328. - BodyType2D bodyType
  4329. - float mass
  4330. - float inertia
  4331. - Vector2 massCenter
  4332. - bool useFixtureMass
  4333. - float linearDamping
  4334. - float angularDamping
  4335. - bool allowSleep
  4336. - bool fixedRotation
  4337. - bool bullet
  4338. - float gravityScale
  4339. - bool awake
  4340. - Vector2 linearVelocity
  4341. - float angularVelocity
  4342. <a name="Class_Scene"></a>
  4343. ### Scene : Node
  4344. Methods:
  4345. - Scene() (GC)
  4346. - Scene* new()
  4347. - void delete()
  4348. - bool Load(File* source)
  4349. - bool Save(File* dest) const
  4350. - bool Load(const String fileName)
  4351. - bool Save(const String fileName) const
  4352. - bool LoadXML(File* source)
  4353. - bool SaveXML(File* dest, const String indentation = "\t") const
  4354. - bool LoadXML(const String fileName)
  4355. - bool SaveXML(const String fileName, const String indentation = "\t") const
  4356. - bool LoadJSON(File* source)
  4357. - bool SaveJSON(File* dest, const String indentation = "\t") const
  4358. - bool LoadJSON(const String fileName)
  4359. - bool SaveJSON(const String fileName, const String indentation = "\t") const
  4360. - Node* Instantiate(File* source, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  4361. - Node* Instantiate(const String fileName, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  4362. - Node* InstantiateXML(File* source, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  4363. - Node* InstantiateXML(const String fileName, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  4364. - bool LoadAsync(File* file, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  4365. - bool LoadAsyncXML(File* file, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  4366. - bool LoadAsync(const String fileName, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  4367. - bool LoadAsyncXML(const String fileName, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  4368. - void StopAsyncLoading()
  4369. - void Clear(bool clearReplicated = true, bool clearLocal = true)
  4370. - void SetUpdateEnabled(bool enable)
  4371. - void SetTimeScale(float scale)
  4372. - void SetElapsedTime(float time)
  4373. - void SetSmoothingConstant(float constant)
  4374. - void SetSnapThreshold(float threshold)
  4375. - void SetAsyncLoadingMs(int ms)
  4376. - Node* GetNode(unsigned id) const
  4377. - bool IsUpdateEnabled() const
  4378. - bool IsAsyncLoading() const
  4379. - float GetAsyncProgress() const
  4380. - LoadMode GetAsyncLoadMode() const
  4381. - const String GetFileName() const
  4382. - unsigned GetChecksum() const
  4383. - float GetTimeScale() const
  4384. - float GetElapsedTime() const
  4385. - float GetSmoothingConstant() const
  4386. - float GetSnapThreshold() const
  4387. - int GetAsyncLoadingMs() const
  4388. - const String GetVarName(StringHash hash) const
  4389. - void Update(float timeStep)
  4390. - void BeginThreadedUpdate()
  4391. - void EndThreadedUpdate()
  4392. - void DelayedMarkedDirty(Component* component)
  4393. - bool IsThreadedUpdate() const
  4394. - unsigned GetFreeNodeID(CreateMode mode)
  4395. - unsigned GetFreeComponentID(CreateMode mode)
  4396. - void NodeAdded(Node* node)
  4397. - void NodeRemoved(Node* node)
  4398. - void ComponentAdded(Component* component)
  4399. - void ComponentRemoved(Component* component)
  4400. - void SetVarNamesAttr(const String value)
  4401. - String GetVarNamesAttr() const
  4402. - void PrepareNetworkUpdate()
  4403. - void CleanupConnection(Connection* connection)
  4404. - void MarkNetworkUpdate(Node* node)
  4405. - void MarkNetworkUpdate(Component* component)
  4406. - void MarkReplicationDirty(Node* node)
  4407. Properties:
  4408. - bool updateEnabled
  4409. - bool asyncLoading (readonly)
  4410. - float asyncProgress (readonly)
  4411. - LoadMode asyncLoadMode (readonly)
  4412. - const String fileName
  4413. - unsigned checksum (readonly)
  4414. - float timeScale
  4415. - float elapsedTime
  4416. - float smoothingConstant
  4417. - float snapThreshold
  4418. - int asyncLoadingMs
  4419. - bool threadedUpdate (readonly)
  4420. - String varNamesAttr
  4421. <a name="Class_ScrollBar"></a>
  4422. ### ScrollBar : UIElement
  4423. Methods:
  4424. - ScrollBar() (GC)
  4425. - ScrollBar* new()
  4426. - void delete()
  4427. - void SetOrientation(Orientation orientation)
  4428. - void SetRange(float range)
  4429. - void SetValue(float value)
  4430. - void ChangeValue(float delta)
  4431. - void SetScrollStep(float step)
  4432. - void SetStepFactor(float factor)
  4433. - void StepBack()
  4434. - void StepForward()
  4435. - Orientation GetOrientation() const
  4436. - float GetRange() const
  4437. - float GetValue() const
  4438. - float GetScrollStep() const
  4439. - float GetStepFactor() const
  4440. - float GetEffectiveScrollStep() const
  4441. - Button* GetBackButton() const
  4442. - Button* GetForwardButton() const
  4443. - Slider* GetSlider() const
  4444. Properties:
  4445. - Orientation orientation
  4446. - float range
  4447. - float value
  4448. - float scrollStep
  4449. - float stepFactor
  4450. - float effectiveScrollStep (readonly)
  4451. - Button* backButton (readonly)
  4452. - Button* forwardButton (readonly)
  4453. - Slider* slider (readonly)
  4454. <a name="Class_ScrollView"></a>
  4455. ### ScrollView : UIElement
  4456. Methods:
  4457. - ScrollView() (GC)
  4458. - ScrollView* new()
  4459. - void delete()
  4460. - void SetContentElement(UIElement* element)
  4461. - void SetViewPosition(const IntVector2& position)
  4462. - void SetViewPosition(int x, int y)
  4463. - void SetScrollBarsVisible(bool horizontal, bool vertical)
  4464. - void SetScrollBarsAutoVisible(bool enable)
  4465. - void SetScrollStep(float step)
  4466. - void SetPageStep(float step)
  4467. - void SetScrollDeceleration(float deceleration)
  4468. - void SetScrollSnapEpsilon(float snap)
  4469. - void SetAutoDisableChildren(bool disable)
  4470. - void SetAutoDisableThreshold(float amount)
  4471. - const IntVector2& GetViewPosition() const
  4472. - UIElement* GetContentElement() const
  4473. - ScrollBar* GetHorizontalScrollBar() const
  4474. - ScrollBar* GetVerticalScrollBar() const
  4475. - BorderImage* GetScrollPanel() const
  4476. - bool GetScrollBarsAutoVisible() const
  4477. - float GetScrollStep() const
  4478. - float GetPageStep() const
  4479. - float GetScrollDeceleration() const
  4480. - float GetScrollSnapEpsilon() const
  4481. - bool GetAutoDisableChildren() const
  4482. - float GetAutoDisableThreshold() const
  4483. Properties:
  4484. - IntVector2& viewPosition
  4485. - UIElement* contentElement
  4486. - ScrollBar* horizontalScrollBar (readonly)
  4487. - ScrollBar* verticalScrollBar (readonly)
  4488. - BorderImage* scrollPanel (readonly)
  4489. - bool scrollBarsAutoVisible
  4490. - float scrollStep
  4491. - float pageStep
  4492. - float scrollDeceleration
  4493. - float scrollSnapEpsilon
  4494. <a name="Class_Serializable"></a>
  4495. ### Serializable : Object
  4496. Methods:
  4497. - void SetTemporary(bool enable)
  4498. - bool IsTemporary() const
  4499. - void SetInterceptNetworkUpdate(const String attributeName, bool enable)
  4500. - bool GetInterceptNetworkUpdate(const String attributeName)
  4501. Properties:
  4502. - bool temporary
  4503. <a name="Class_Serializer"></a>
  4504. ### Serializer
  4505. Methods:
  4506. - unsigned Write(const VectorBuffer& buffer)
  4507. - bool WriteInt(int value)
  4508. - bool WriteShort(short value)
  4509. - bool WriteByte(char value)
  4510. - bool WriteUInt(unsigned value)
  4511. - bool WriteUShort(short value)
  4512. - bool WriteUByte(char value)
  4513. - bool WriteBool(bool value)
  4514. - bool WriteFloat(float value)
  4515. - bool WriteDouble(double value)
  4516. - bool WriteIntRect(const IntRect& value)
  4517. - bool WriteIntVector2(const IntVector2& value)
  4518. - bool WriteRect(const Rect& value)
  4519. - bool WriteVector2(const Vector2& value)
  4520. - bool WriteVector3(const Vector3& value)
  4521. - bool WritePackedVector3(const Vector3& value, float maxAbsCoord)
  4522. - bool WriteVector4(const Vector4& value)
  4523. - bool WriteQuaternion(const Quaternion& value)
  4524. - bool WritePackedQuaternion(const Quaternion& value)
  4525. - bool WriteMatrix3(const Matrix3& value)
  4526. - bool WriteMatrix3x4(const Matrix3x4& value)
  4527. - bool WriteMatrix4(const Matrix4& value)
  4528. - bool WriteColor(const Color& value)
  4529. - bool WriteBoundingBox(const BoundingBox& value)
  4530. - bool WriteString(const String value)
  4531. - bool WriteFileID(const String value)
  4532. - bool WriteStringHash(const StringHash& value)
  4533. - bool WriteBuffer(const VectorBuffer& buffer)
  4534. - bool WriteResourceRef(const ResourceRef& value)
  4535. - bool WriteResourceRefList(const ResourceRefList& value)
  4536. - bool WriteVariant(const Variant& value)
  4537. - bool WriteVariantData(const Variant& value)
  4538. - bool WriteVariantVector(const VariantVector& value)
  4539. - bool WriteVariantMap(const VariantMap& value)
  4540. - bool WriteVLE(unsigned value)
  4541. - bool WriteNetID(unsigned value)
  4542. - bool WriteLine(const String value)
  4543. <a name="Class_Skeleton"></a>
  4544. ### Skeleton
  4545. Methods:
  4546. - unsigned GetNumBones() const
  4547. - Bone* GetRootBone()
  4548. - Bone* GetBone(const String name)
  4549. - Bone* GetBone(unsigned index)
  4550. Properties:
  4551. - unsigned numBones (readonly)
  4552. - Bone* rootBone (readonly)
  4553. <a name="Class_Skybox"></a>
  4554. ### Skybox : StaticModel
  4555. <a name="Class_Slider"></a>
  4556. ### Slider : BorderImage
  4557. Methods:
  4558. - Slider() (GC)
  4559. - Slider* new()
  4560. - void delete()
  4561. - void SetOrientation(Orientation orientation)
  4562. - void SetRange(float range)
  4563. - void SetValue(float value)
  4564. - void ChangeValue(float delta)
  4565. - void SetRepeatRate(float rate)
  4566. - Orientation GetOrientation() const
  4567. - float GetRange() const
  4568. - float GetValue() const
  4569. - BorderImage* GetKnob() const
  4570. - float GetRepeatRate() const
  4571. Properties:
  4572. - Orientation orientation
  4573. - float range
  4574. - float value
  4575. - BorderImage* knob (readonly)
  4576. - float repeatRate
  4577. <a name="Class_Sound"></a>
  4578. ### Sound : Resource
  4579. Methods:
  4580. - Sound() (GC)
  4581. - Sound* new()
  4582. - void delete()
  4583. - bool LoadRaw(Deserializer& source)
  4584. - bool LoadWav(Deserializer& source)
  4585. - bool LoadOggVorbis(Deserializer& source)
  4586. - bool LoadRaw(const String fileName)
  4587. - bool LoadWav(const String fileName)
  4588. - bool LoadOggVorbis(const String fileName)
  4589. - void SetSize(unsigned dataSize)
  4590. - void SetData(const void* data, unsigned dataSize)
  4591. - void SetFormat(unsigned frequency, bool sixteenBit, bool stereo)
  4592. - void SetLooped(bool enable)
  4593. - void SetLoop(unsigned repeatOffset, unsigned endOffset)
  4594. - void FixInterpolation()
  4595. - float GetLength() const
  4596. - unsigned GetDataSize() const
  4597. - unsigned GetSampleSize() const
  4598. - float GetFrequency() const
  4599. - unsigned GetIntFrequency() const
  4600. - bool IsLooped() const
  4601. - bool IsSixteenBit() const
  4602. - bool IsStereo() const
  4603. - bool IsCompressed() const
  4604. Properties:
  4605. - float length (readonly)
  4606. - unsigned dataSize (readonly)
  4607. - unsigned sampleSize (readonly)
  4608. - float frequency (readonly)
  4609. - int intFrequency (readonly)
  4610. - bool looped
  4611. - bool sixteenBit (readonly)
  4612. - bool stereo (readonly)
  4613. - bool compressed (readonly)
  4614. <a name="Class_SoundListener"></a>
  4615. ### SoundListener : Component
  4616. <a name="Class_SoundSource"></a>
  4617. ### SoundSource : Component
  4618. Methods:
  4619. - void Play(Sound* sound)
  4620. - void Play(Sound* sound, float frequency)
  4621. - void Play(Sound* sound, float frequency, float gain)
  4622. - void Play(Sound* sound, float frequency, float gain, float panning)
  4623. - void Stop()
  4624. - void SetSoundType(const String type)
  4625. - void SetFrequency(float frequency)
  4626. - void SetGain(float gain)
  4627. - void SetAttenuation(float attenuation)
  4628. - void SetPanning(float panning)
  4629. - void SetAutoRemove(bool enable)
  4630. - Sound* GetSound() const
  4631. - String GetSoundType() const
  4632. - float GetTimePosition() const
  4633. - float GetFrequency() const
  4634. - float GetGain() const
  4635. - float GetAttenuation() const
  4636. - float GetPanning() const
  4637. - bool GetAutoRemove() const
  4638. - bool IsPlaying() const
  4639. Properties:
  4640. - Sound* sound (readonly)
  4641. - String soundType
  4642. - float timePosition (readonly)
  4643. - float frequency
  4644. - float gain
  4645. - float attenuation
  4646. - float panning
  4647. - bool autoRemove
  4648. - bool playing (readonly)
  4649. <a name="Class_SoundSource3D"></a>
  4650. ### SoundSource3D : SoundSource
  4651. Methods:
  4652. - void SetDistanceAttenuation(float nearDistance, float farDistance, float rolloffFactor)
  4653. - void SetAngleAttenuation(float innerAngle, float outerAngle)
  4654. - void SetNearDistance(float distance)
  4655. - void SetFarDistance(float distance)
  4656. - void SetInnerAngle(float angle)
  4657. - void SetOuterAngle(float angle)
  4658. - void SetRolloffFactor(float factor)
  4659. - void CalculateAttenuation()
  4660. - float GetNearDistance() const
  4661. - float GetFarDistance() const
  4662. - float GetInnerAngle() const
  4663. - float GetOuterAngle() const
  4664. - float RollAngleoffFactor() const
  4665. Properties:
  4666. - float nearDistance
  4667. - float farDistance
  4668. - float innerAngle
  4669. - float outerAngle
  4670. - float rolloffFactor
  4671. <a name="Class_Sphere"></a>
  4672. ### Sphere
  4673. Methods:
  4674. - Sphere() (GC)
  4675. - Sphere* new()
  4676. - Sphere(const Sphere& sphere) (GC)
  4677. - Sphere* new(const Sphere& sphere)
  4678. - Sphere(const Vector3& center, float radius) (GC)
  4679. - Sphere* new(const Vector3& center, float radius)
  4680. - Sphere(const BoundingBox& box) (GC)
  4681. - Sphere* new(const BoundingBox& box)
  4682. - Sphere(const Frustum& frustum) (GC)
  4683. - Sphere* new(const Frustum& frustum)
  4684. - Sphere(const Polyhedron& poly) (GC)
  4685. - Sphere* new(const Polyhedron& poly)
  4686. - void delete()
  4687. - bool operator==(const Sphere& rhs) const
  4688. - void Define(const Sphere& sphere)
  4689. - void Define(const Vector3& center, float radius)
  4690. - void Define(const BoundingBox& box)
  4691. - void Define(const Frustum& frustum)
  4692. - void Define(const Polyhedron& poly)
  4693. - void Merge(const Vector3& point)
  4694. - void Merge(const BoundingBox& box)
  4695. - void Merge(const Frustum& frustum)
  4696. - void Merge(const Polyhedron& poly)
  4697. - void Merge(const Sphere& sphere)
  4698. - void Clear()
  4699. - bool Defined() const
  4700. - Intersection IsInside(const Vector3& point) const
  4701. - Intersection IsInside(const Sphere& sphere) const
  4702. - Intersection IsInsideFast(const Sphere& sphere) const
  4703. - Intersection IsInside(const BoundingBox& box) const
  4704. - Intersection IsInsideFast(const BoundingBox& box) const
  4705. - float Distance(const Vector3& point) const
  4706. Properties:
  4707. - Vector3 center
  4708. - float radius
  4709. <a name="Class_Spline"></a>
  4710. ### Spline
  4711. Methods:
  4712. - Spline() (GC)
  4713. - Spline* new()
  4714. - Spline(InterpolationMode mode) (GC)
  4715. - Spline* new(InterpolationMode mode)
  4716. - Spline(const Spline& rhs) (GC)
  4717. - Spline* new(const Spline& rhs)
  4718. - void delete()
  4719. - bool operator==(const Spline& rhs) const
  4720. - Variant GetPoint(float f) const
  4721. - Variant GetKnot(unsigned index) const
  4722. - void SetKnot(const Variant& knot, unsigned tolua_var_1)
  4723. - void AddKnot(const Variant& knot)
  4724. - void AddKnot(const Variant& knot, unsigned index)
  4725. - void RemoveKnot()
  4726. - void RemoveKnot(unsigned index)
  4727. - void Clear()
  4728. Properties:
  4729. - InterpolationMode interpolationMode
  4730. <a name="Class_SplinePath"></a>
  4731. ### SplinePath : Component
  4732. Methods:
  4733. - void AddControlPoint(Node* point, unsigned index = M_MAX_UNSIGNED)
  4734. - void RemoveControlPoint(Node* point)
  4735. - void ClearControlPoints()
  4736. - void SetInterpolationMode(InterpolationMode mode)
  4737. - void SetPosition(float factor)
  4738. - void SetControlledNode(Node* controlled)
  4739. - InterpolationMode GetInterpolationMode() const
  4740. - float GetSpeed() const
  4741. - float GetLength() const
  4742. - Vector3 GetPosition() const
  4743. - Node* GetControlledNode() const
  4744. - Vector3 GetPoint(float factor) const
  4745. - void Move(float timeStep)
  4746. - void Reset()
  4747. - bool IsFinished() const
  4748. Properties:
  4749. - InterpolationMode interpolationMode
  4750. - float speed
  4751. - float length (readonly)
  4752. - Node* controlledNode
  4753. <a name="Class_Sprite"></a>
  4754. ### Sprite : UIElement
  4755. Methods:
  4756. - Sprite() (GC)
  4757. - Sprite* new()
  4758. - void delete()
  4759. - void SetPosition(const Vector2& position)
  4760. - void SetPosition(float x, float y)
  4761. - void SetHotSpot(const IntVector2& hotSpot)
  4762. - void SetHotSpot(int x, int y)
  4763. - void SetScale(const Vector2& scale)
  4764. - void SetScale(float x, float y)
  4765. - void SetScale(float scale)
  4766. - void SetRotation(float angle)
  4767. - void SetTexture(Texture* texture)
  4768. - void SetImageRect(const IntRect& rect)
  4769. - void SetFullImageRect()
  4770. - void SetBlendMode(BlendMode mode)
  4771. - const Vector2& GetPosition() const
  4772. - const IntVector2& GetHotSpot() const
  4773. - const Vector2& GetScale() const
  4774. - float GetRotation() const
  4775. - Texture* GetTexture() const
  4776. - const IntRect& GetImageRect() const
  4777. - BlendMode GetBlendMode() const
  4778. - const Matrix3x4& GetTransform() const
  4779. Properties:
  4780. - Vector2& position
  4781. - IntVector2& hotSpot
  4782. - Vector2& scale
  4783. - float rotation
  4784. - Texture* texture
  4785. - IntRect& imageRect
  4786. - BlendMode blendMode
  4787. - Matrix3x4& transform (readonly)
  4788. <a name="Class_Sprite2D"></a>
  4789. ### Sprite2D : Resource
  4790. Methods:
  4791. - void SetTexture(Texture2D* texture)
  4792. - void SetRectangle(const IntRect& rectangle)
  4793. - void SetHotSpot(const Vector2& hotSpot)
  4794. - void SetOffset(const IntVector2& offset)
  4795. - void SetSpriteSheet(SpriteSheet2D* spriteSheet)
  4796. - Texture2D* GetTexture() const
  4797. - const IntRect& GetRectangle() const
  4798. - const Vector2& GetHotSpot() const
  4799. - const IntVector2& GetOffset() const
  4800. - SpriteSheet2D* GetSpriteSheet() const
  4801. Properties:
  4802. - Texture2D* texture
  4803. - IntRect rectangle
  4804. - Vector2 hotSpot
  4805. - IntVector2 offset
  4806. - SpriteSheet2D* spriteSheet
  4807. <a name="Class_SpriteSheet2D"></a>
  4808. ### SpriteSheet2D : Resource
  4809. Methods:
  4810. - Texture2D* GetTexture() const
  4811. - Sprite2D* GetSprite(const String name) const
  4812. - void DefineSprite(const String name, const IntRect& rectangle)
  4813. - void DefineSprite(const String name, const IntRect& rectangle, const Vector2& hotSpot)
  4814. - void DefineSprite(const String name, const IntRect& rectangle, const Vector2& hotSpot, const IntVector2& originSize)
  4815. <a name="Class_StaticModel"></a>
  4816. ### StaticModel : Drawable
  4817. Methods:
  4818. - void SetModel(Model* model)
  4819. - void SetMaterial(Material* material)
  4820. - bool SetMaterial(unsigned index, Material* material)
  4821. - void SetOcclusionLodLevel(unsigned level)
  4822. - void ApplyMaterialList(const String fileName = String::EMPTY)
  4823. - Model* GetModel() const
  4824. - unsigned GetNumGeometries() const
  4825. - Material* GetMaterial(unsigned index = 0) const
  4826. - unsigned GetOcclusionLodLevel() const
  4827. - bool IsInside(const Vector3& point) const
  4828. - bool IsInsideLocal(const Vector3& point) const
  4829. Properties:
  4830. - Model* model
  4831. - Material* material
  4832. - BoundingBox& boundingBox (readonly)
  4833. - unsigned numGeometries (readonly)
  4834. - unsigned occlusionLodLevel
  4835. <a name="Class_StaticModelGroup"></a>
  4836. ### StaticModelGroup : StaticModel
  4837. Methods:
  4838. - void AddInstanceNode(Node* node)
  4839. - void RemoveInstanceNode(Node* node)
  4840. - void RemoveAllInstanceNodes()
  4841. - unsigned GetNumInstanceNodes() const
  4842. - Node* GetInstanceNode(unsigned index) const
  4843. Properties:
  4844. - unsigned numInstanceNodes (readonly)
  4845. <a name="Class_StaticSprite2D"></a>
  4846. ### StaticSprite2D : Drawable2D
  4847. Methods:
  4848. - void SetSprite(Sprite2D* sprite)
  4849. - void SetBlendMode(BlendMode mode)
  4850. - void SetFlip(bool flipX, bool flipY)
  4851. - void SetFlipX(bool flipX)
  4852. - void SetFlipY(bool flipY)
  4853. - void SetColor(const Color& color)
  4854. - void SetAlpha(float alpha)
  4855. - void SetUseHotSpot(bool useHotSpot)
  4856. - void SetHotSpot(const Vector2& hotspot)
  4857. - void SetCustomMaterial(Material* customMaterial)
  4858. - Sprite2D* GetSprite() const
  4859. - BlendMode GetBlendMode() const
  4860. - bool GetFlipX() const
  4861. - bool GetFlipY() const
  4862. - const Color& GetColor() const
  4863. - float GetAlpha() const
  4864. - bool GetUseHotSpot() const
  4865. - const Vector2& GetHotSpot() const
  4866. - Material* GetCustomMaterial() const
  4867. Properties:
  4868. - Sprite2D* sprite
  4869. - BlendMode blendMode
  4870. - bool flipX
  4871. - bool flipY
  4872. - Color& color
  4873. - float alpha
  4874. - bool useHotSpot
  4875. - Vector2 hotSpot
  4876. - Material* customMaterial
  4877. <a name="Class_StringHash"></a>
  4878. ### StringHash
  4879. Methods:
  4880. - StringHash() (GC)
  4881. - StringHash* new()
  4882. - StringHash(const StringHash& rhs) (GC)
  4883. - StringHash* new(const StringHash& rhs)
  4884. - StringHash(const char* str) (GC)
  4885. - StringHash* new(const char* str)
  4886. - StringHash(unsigned value) (GC)
  4887. - StringHash* new(unsigned value)
  4888. - void delete()
  4889. - StringHash operator+(const StringHash& rhs) const
  4890. - bool operator==(const StringHash& rhs) const
  4891. - bool operator<(const StringHash& rhs) const
  4892. - bool operatorbool() const
  4893. - unsigned Value() const
  4894. - String ToString() const
  4895. - unsigned ToHash() const
  4896. - unsigned Calculate(const char* str)
  4897. Properties:
  4898. - const StringHash ZERO
  4899. - unsigned value (readonly)
  4900. <a name="Class_Technique"></a>
  4901. ### Technique : Resource
  4902. Methods:
  4903. - bool HasPass(const String type) const
  4904. - Pass* GetPass(const String type) const
  4905. - Pass* GetSupportedPass(const String type) const
  4906. - bool IsSupported() const
  4907. - bool IsDesktop() const
  4908. - unsigned GetNumPasses() const
  4909. - const Vector<String>& GetPassTypes() const
  4910. - const PODVector<Pass*>& GetPasses() const
  4911. Properties:
  4912. - bool supported (readonly)
  4913. - bool desktop (readonly)
  4914. - unsigned numPasses (readonly)
  4915. <a name="Class_Terrain"></a>
  4916. ### Terrain : Component
  4917. Methods:
  4918. - void SetPatchSize(int size)
  4919. - void SetSpacing(const Vector3& spacing)
  4920. - void SetMaxLodLevels(unsigned levels)
  4921. - void SetOcclusionLodLevel(unsigned level)
  4922. - void SetSmoothing(bool enable)
  4923. - bool SetHeightMap(Image* image)
  4924. - void SetMaterial(Material* material)
  4925. - void SetDrawDistance(float distance)
  4926. - void SetShadowDistance(float distance)
  4927. - void SetLodBias(float bias)
  4928. - void SetViewMask(unsigned mask)
  4929. - void SetLightMask(unsigned mask)
  4930. - void SetShadowMask(unsigned mask)
  4931. - void SetZoneMask(unsigned mask)
  4932. - void SetMaxLights(unsigned num)
  4933. - void SetCastShadows(bool enable)
  4934. - void SetOccluder(bool enable)
  4935. - void SetOccludee(bool enable)
  4936. - void ApplyHeightMap()
  4937. - int GetPatchSize() const
  4938. - const Vector3& GetSpacing() const
  4939. - const IntVector2& GetNumVertices() const
  4940. - const IntVector2& GetNumPatches() const
  4941. - unsigned GetMaxLodLevels() const
  4942. - unsigned GetOcclusionLodLevel() const
  4943. - bool GetSmoothing() const
  4944. - Image* GetHeightMap() const
  4945. - Material* GetMaterial() const
  4946. - TerrainPatch* GetPatch(unsigned index) const
  4947. - TerrainPatch* GetPatch(int x, int z) const
  4948. - float GetHeight(const Vector3& worldPosition) const
  4949. - Vector3 GetNormal(const Vector3& worldPosition) const
  4950. - IntVector2 WorldToHeightMap(const Vector3& worldPosition) const
  4951. - SharedArrayPtr<float> GetHeightData() const
  4952. - float GetDrawDistance() const
  4953. - float GetShadowDistance() const
  4954. - float GetLodBias() const
  4955. - unsigned GetViewMask() const
  4956. - unsigned GetLightMask() const
  4957. - unsigned GetShadowMask() const
  4958. - unsigned GetZoneMask() const
  4959. - unsigned GetMaxLights() const
  4960. - bool IsVisible() const
  4961. - bool GetCastShadows() const
  4962. - bool IsOccluder() const
  4963. - bool IsOccludee() const
  4964. Properties:
  4965. - int patchSize
  4966. - Vector3& spacing
  4967. - IntVector2& numVertices (readonly)
  4968. - IntVector2& numPatches (readonly)
  4969. - unsigned maxLodLevels
  4970. - unsigned occlusionLodLevel
  4971. - bool smoothing
  4972. - Image* heightMap
  4973. - Material* material
  4974. - float drawDistance
  4975. - float shadowDistance
  4976. - float lodBias
  4977. - unsigned viewMask
  4978. - unsigned lightMask
  4979. - unsigned shadowMask
  4980. - unsigned zoneMask
  4981. - unsigned maxLights
  4982. - bool visible (readonly)
  4983. - bool castShadows
  4984. - bool occluder
  4985. - bool occludee
  4986. <a name="Class_TerrainPatch"></a>
  4987. ### TerrainPatch : Drawable
  4988. Methods:
  4989. - void SetOwner(Terrain* terrain)
  4990. - void SetNeighbors(TerrainPatch* north, TerrainPatch* south, TerrainPatch* west, TerrainPatch* east)
  4991. - void SetMaterial(Material* material)
  4992. - void SetBoundingBox(const BoundingBox& box)
  4993. - void SetCoordinates(const IntVector2& coordinates)
  4994. - void ResetLod()
  4995. - Geometry* GetGeometry() const
  4996. - Geometry* GetMaxLodGeometry() const
  4997. - Geometry* GetOcclusionGeometry() const
  4998. - VertexBuffer* GetVertexBuffer() const
  4999. - Terrain* GetOwner() const
  5000. - TerrainPatch* GetNorthPatch() const
  5001. - TerrainPatch* GetSouthPatch() const
  5002. - TerrainPatch* GetWestPatch() const
  5003. - TerrainPatch* GetEastPatch() const
  5004. - const IntVector2& GetCoordinates() const
  5005. - unsigned GetLodLevel() const
  5006. Properties:
  5007. - Geometry* geometry (readonly)
  5008. - Geometry* maxLodGeometry (readonly)
  5009. - Geometry* occlusionGeometry (readonly)
  5010. - VertexBuffer* vertexBuffer (readonly)
  5011. - Terrain* owner
  5012. - TerrainPatch* northPatch (readonly)
  5013. - TerrainPatch* southPatch (readonly)
  5014. - TerrainPatch* westPatch (readonly)
  5015. - TerrainPatch* eastPatch (readonly)
  5016. - BoundingBox& boundingBox
  5017. - IntVector2& coordinates
  5018. - unsigned lodLevel (readonly)
  5019. <a name="Class_Text"></a>
  5020. ### Text : UIElement
  5021. Methods:
  5022. - Text() (GC)
  5023. - Text* new()
  5024. - void delete()
  5025. - bool SetFont(const String fontName, int size = DEFAULT_FONT_SIZE)
  5026. - bool SetFont(Font* font, int size = DEFAULT_FONT_SIZE)
  5027. - void SetText(const String text)
  5028. - void SetTextAlignment(HorizontalAlignment align)
  5029. - void SetRowSpacing(float spacing)
  5030. - void SetWordwrap(bool enable)
  5031. - void SetSelection(unsigned start, unsigned length = M_MAX_UNSIGNED)
  5032. - void ClearSelection()
  5033. - void SetSelectionColor(const Color& color)
  5034. - void SetHoverColor(const Color& color)
  5035. - void SetTextEffect(TextEffect textEffect)
  5036. - void SetEffectColor(const Color& effectColor)
  5037. - bool GetAutoLocalizable() const
  5038. - void SetAutoLocalizable(bool enable)
  5039. - Font* GetFont() const
  5040. - int GetFontSize() const
  5041. - const String GetText() const
  5042. - HorizontalAlignment GetTextAlignment() const
  5043. - float GetRowSpacing() const
  5044. - bool GetWordwrap() const
  5045. - unsigned GetSelectionStart() const
  5046. - unsigned GetSelectionLength() const
  5047. - const Color& GetSelectionColor() const
  5048. - const Color& GetHoverColor() const
  5049. - TextEffect GetTextEffect() const
  5050. - const Color& GetEffectColor() const
  5051. - int GetRowHeight() const
  5052. - unsigned GetNumRows() const
  5053. - unsigned GetNumChars() const
  5054. - int GetRowWidth(unsigned index) const
  5055. - IntVector2 GetCharPosition(unsigned index)
  5056. - IntVector2 GetCharSize(unsigned index)
  5057. - void SetEffectDepthBias(float bias)
  5058. - float GetEffectDepthBias() const
  5059. Properties:
  5060. - Font* font
  5061. - int fontSize (readonly)
  5062. - String text
  5063. - HorizontalAlignment textAlignment
  5064. - float rowSpacing
  5065. - bool wordwrap
  5066. - bool autoLocalizable
  5067. - unsigned selectionStart (readonly)
  5068. - unsigned selectionLength (readonly)
  5069. - Color& selectionColor
  5070. - Color& hoverColor
  5071. - TextEffect textEffect
  5072. - Color& effectColor
  5073. - int rowHeight (readonly)
  5074. - unsigned numRows (readonly)
  5075. - unsigned numChars (readonly)
  5076. <a name="Class_Text3D"></a>
  5077. ### Text3D : Drawable
  5078. Methods:
  5079. - Text3D() (GC)
  5080. - Text3D* new()
  5081. - void delete()
  5082. - bool SetFont(const String fontName, int size = DEFAULT_FONT_SIZE)
  5083. - bool SetFont(Font* font, int size = DEFAULT_FONT_SIZE)
  5084. - void SetMaterial(Material* material)
  5085. - void SetText(const String text)
  5086. - void SetAlignment(HorizontalAlignment hAlign, VerticalAlignment vAlign)
  5087. - void SetHorizontalAlignment(HorizontalAlignment align)
  5088. - void SetVerticalAlignment(VerticalAlignment align)
  5089. - void SetTextAlignment(HorizontalAlignment align)
  5090. - void SetRowSpacing(float spacing)
  5091. - void SetWordwrap(bool enable)
  5092. - void SetTextEffect(TextEffect textEffect)
  5093. - void SetEffectColor(const Color& effectColor)
  5094. - void SetEffectDepthBias(float bias)
  5095. - void SetWidth(int width)
  5096. - void SetColor(const Color& color)
  5097. - void SetColor(Corner corner, const Color& color)
  5098. - void SetOpacity(float opacity)
  5099. - void SetFaceCameraMode(FaceCameraMode mode)
  5100. - Font* GetFont() const
  5101. - Material* GetMaterial() const
  5102. - int GetFontSize() const
  5103. - const String GetText() const
  5104. - HorizontalAlignment GetTextAlignment() const
  5105. - HorizontalAlignment GetHorizontalAlignment() const
  5106. - VerticalAlignment GetVerticalAlignment() const
  5107. - float GetRowSpacing() const
  5108. - bool GetWordwrap() const
  5109. - TextEffect GetTextEffect() const
  5110. - const Color& GetEffectColor() const
  5111. - float GetEffectDepthBias() const
  5112. - int GetWidth() const
  5113. - int GetRowHeight() const
  5114. - unsigned GetNumRows() const
  5115. - unsigned GetNumChars() const
  5116. - int GetRowWidth(unsigned index) const
  5117. - IntVector2 GetCharPosition(unsigned index)
  5118. - IntVector2 GetCharSize(unsigned index)
  5119. - const Color& GetColor(Corner corner) const
  5120. - float GetOpacity() const
  5121. - FaceCameraMode GetFaceCameraMode() const
  5122. Properties:
  5123. - Font* font
  5124. - Material* material
  5125. - int fontSize (readonly)
  5126. - String text
  5127. - HorizontalAlignment textAlignment
  5128. - HorizontalAlignment horizontalAlignment
  5129. - VerticalAlignment verticalAlignment
  5130. - float rowSpacing
  5131. - bool wordwrap
  5132. - TextEffect textEffect
  5133. - Color& effectColor
  5134. - float effectDepthBias
  5135. - int width
  5136. - Color& color
  5137. - int rowHeight (readonly)
  5138. - unsigned numRows (readonly)
  5139. - unsigned numChars (readonly)
  5140. - float opacity
  5141. - FaceCameraMode faceCameraMode
  5142. <a name="Class_Texture"></a>
  5143. ### Texture : Resource
  5144. Methods:
  5145. - void SetNumLevels(unsigned levels)
  5146. - void SetFilterMode(TextureFilterMode filter)
  5147. - void SetAddressMode(TextureCoordinate coord, TextureAddressMode address)
  5148. - void SetBorderColor(const Color& color)
  5149. - void SetSRGB(bool enable)
  5150. - void SetBackupTexture(Texture* texture)
  5151. - void SetMipsToSkip(int quality, int toSkip)
  5152. - unsigned GetFormat() const
  5153. - bool IsCompressed() const
  5154. - unsigned GetLevels() const
  5155. - int GetWidth() const
  5156. - int GetHeight() const
  5157. - TextureFilterMode GetFilterMode() const
  5158. - TextureAddressMode GetAddressMode(TextureCoordinate coord) const
  5159. - const Color& GetBorderColor() const
  5160. - bool GetSRGB() const
  5161. - Texture* GetBackupTexture() const
  5162. - int GetMipsToSkip(int quality) const
  5163. - int GetLevelWidth(unsigned level) const
  5164. - int GetLevelHeight(unsigned level) const
  5165. - TextureUsage GetUsage() const
  5166. - unsigned GetDataSize(int width, int height) const
  5167. - unsigned GetRowDataSize(int width) const
  5168. - unsigned GetComponents() const
  5169. Properties:
  5170. - unsigned format (readonly)
  5171. - bool compressed (readonly)
  5172. - unsigned levels (readonly)
  5173. - int width (readonly)
  5174. - int height (readonly)
  5175. - unsigned components (readonly)
  5176. - TextureFilterMode filterMode
  5177. - Color& borderColor
  5178. - bool sRGB
  5179. - Texture* backupTexture
  5180. - TextureUsage usage (readonly)
  5181. <a name="Class_Texture2D"></a>
  5182. ### Texture2D : Texture
  5183. Methods:
  5184. - Texture2D() (GC)
  5185. - Texture2D* new()
  5186. - void delete()
  5187. - bool SetSize(int width, int height, unsigned format, TextureUsage usage = TEXTURE_STATIC)
  5188. - bool SetData(Image* image, bool useAlpha = false)
  5189. - RenderSurface* GetRenderSurface() const
  5190. Properties:
  5191. - RenderSurface* renderSurface (readonly)
  5192. <a name="Class_Texture3D"></a>
  5193. ### Texture3D : Texture
  5194. Methods:
  5195. - Texture3D() (GC)
  5196. - Texture3D* new()
  5197. - void delete()
  5198. - bool SetSize(int width, int height, int depth, unsigned format, TextureUsage usage = TEXTURE_STATIC)
  5199. - bool SetData(Image* image, bool useAlpha = false)
  5200. <a name="Class_TextureCube"></a>
  5201. ### TextureCube : Texture
  5202. Methods:
  5203. - RenderSurface* GetRenderSurface(CubeMapFace face) const
  5204. <a name="Class_TextureFrame"></a>
  5205. ### TextureFrame
  5206. Methods:
  5207. - TextureFrame() (GC)
  5208. - TextureFrame* new()
  5209. - void delete()
  5210. Properties:
  5211. - Rect uv
  5212. - float time
  5213. <a name="Class_Tile2D"></a>
  5214. ### Tile2D
  5215. Methods:
  5216. - int GetGid() const
  5217. - Sprite2D* GetSprite() const
  5218. - bool HasProperty(const String name) const
  5219. - const String GetProperty(const String name) const
  5220. Properties:
  5221. - int gid (readonly)
  5222. - Sprite2D* sprite (readonly)
  5223. <a name="Class_TileMap2D"></a>
  5224. ### TileMap2D : Component
  5225. Methods:
  5226. - void SetTmxFile(TmxFile2D* tmxFile)
  5227. - TmxFile2D* GetTmxFile() const
  5228. - const TileMapInfo2D& GetInfo() const
  5229. - unsigned GetNumLayers() const
  5230. - TileMapLayer2D* GetLayer(unsigned index) const
  5231. - Vector2 TileIndexToPosition(int x, int y) const
  5232. - bool PositionToTileIndex(const Vector2& position, int x = 0, int y = 0) const
  5233. Properties:
  5234. - TmxFile2D* tmxFile
  5235. - TileMapInfo2D& info (readonly)
  5236. - unsigned numLayers (readonly)
  5237. <a name="Class_TileMapInfo2D"></a>
  5238. ### TileMapInfo2D
  5239. Methods:
  5240. - float GetMapWidth() const
  5241. - float GetMapHeight() const
  5242. Properties:
  5243. - Orientation2D orientation
  5244. - int width
  5245. - int height
  5246. - float tileWidth
  5247. - float tileHeight
  5248. - float mapWidth (readonly)
  5249. - float mapHeight (readonly)
  5250. <a name="Class_TileMapLayer2D"></a>
  5251. ### TileMapLayer2D : Component
  5252. Methods:
  5253. - void SetDrawOrder(int drawOrder)
  5254. - void SetVisible(bool visible)
  5255. - int GetDrawOrder() const
  5256. - bool IsVisible() const
  5257. - bool HasProperty(const String name) const
  5258. - const String GetProperty(const String name) const
  5259. - TileMapLayerType2D GetLayerType() const
  5260. - int GetWidth() const
  5261. - int GetHeight() const
  5262. - Node* GetTileNode(int x, int y) const
  5263. - Tile2D* GetTile(int x, int y) const
  5264. - unsigned GetNumObjects() const
  5265. - TileMapObject2D* GetObject(unsigned index) const
  5266. - Node* GetObjectNode(unsigned index) const
  5267. - Node* GetImageNode() const
  5268. Properties:
  5269. - int drawOrder (readonly)
  5270. - bool visible (readonly)
  5271. - TileMapLayerType2D layerType (readonly)
  5272. - int width (readonly)
  5273. - int height (readonly)
  5274. - unsigned numObjects (readonly)
  5275. - Node* imageNode (readonly)
  5276. <a name="Class_TileMapObject2D"></a>
  5277. ### TileMapObject2D
  5278. Methods:
  5279. - TileMapObjectType2D GetObjectType() const
  5280. - const String GetName() const
  5281. - const String GetType() const
  5282. - const Vector2& GetPosition() const
  5283. - const Vector2& GetSize() const
  5284. - unsigned GetNumPoints() const
  5285. - const Vector2& GetPoint(unsigned index) const
  5286. - int GetTileGid() const
  5287. - Sprite2D* GetTileSprite() const
  5288. - bool HasProperty(const String name) const
  5289. - const String GetProperty(const String name) const
  5290. Properties:
  5291. - TileMapObjectType2D objectType (readonly)
  5292. - String name (readonly)
  5293. - String type (readonly)
  5294. - Vector2 position (readonly)
  5295. - Vector2 size (readonly)
  5296. - unsigned numPoints (readonly)
  5297. - int tileGid (readonly)
  5298. - Sprite2D* tileSprite (readonly)
  5299. <a name="Class_Time"></a>
  5300. ### Time : Object
  5301. Methods:
  5302. - unsigned GetFrameNumber() const
  5303. - float GetTimeStep() const
  5304. - unsigned GetTimerPeriod() const
  5305. - float GetElapsedTime()
  5306. - unsigned GetSystemTime()
  5307. - unsigned GetTimeSinceEpoch()
  5308. - String GetTimeStamp()
  5309. - void Sleep(unsigned mSec)
  5310. Properties:
  5311. - unsigned frameNumber (readonly)
  5312. - float timeStep (readonly)
  5313. - unsigned timerPeriod (readonly)
  5314. - float elapsedTime (readonly)
  5315. <a name="Class_TmxFile2D"></a>
  5316. ### TmxFile2D : Resource
  5317. <a name="Class_ToolTip"></a>
  5318. ### ToolTip : UIElement
  5319. Methods:
  5320. - ToolTip() (GC)
  5321. - ToolTip* new()
  5322. - void delete()
  5323. - void SetDelay(float delay)
  5324. - float GetDelay() const
  5325. Properties:
  5326. - float delay
  5327. <a name="Class_TouchState"></a>
  5328. ### TouchState
  5329. Methods:
  5330. - UIElement* GetTouchedElement()
  5331. Properties:
  5332. - int touchID
  5333. - IntVector2 position
  5334. - IntVector2 lastPosition
  5335. - IntVector2 delta
  5336. - float pressure
  5337. - UIElement* touchedElement (readonly)
  5338. <a name="Class_UI"></a>
  5339. ### UI : Object
  5340. Methods:
  5341. - void SetCursor(Cursor* cursor)
  5342. - void SetFocusElement(UIElement* element, bool byKey = false)
  5343. - bool SetModalElement(UIElement* modalElement, bool enable)
  5344. - void Clear()
  5345. - void DebugDraw(UIElement* element)
  5346. - UIElement* LoadLayout(File* source, XMLFile* styleFile = 0)
  5347. - UIElement* LoadLayout(const String fileName, XMLFile* styleFile = 0)
  5348. - UIElement* LoadLayout(XMLFile* file, XMLFile* styleFile = 0)
  5349. - bool SaveLayout(Serializer& dest, UIElement* element)
  5350. - void SetClipboardText(const String text)
  5351. - void SetDoubleClickInterval(float interval)
  5352. - void SetDragBeginInterval(float interval)
  5353. - void SetDragBeginDistance(int pixels)
  5354. - void SetDefaultToolTipDelay(float delay)
  5355. - void SetMaxFontTextureSize(int size)
  5356. - void SetNonFocusedMouseWheel(bool nonFocusedMouseWheel)
  5357. - void SetUseSystemClipboard(bool enable)
  5358. - void SetUseScreenKeyboard(bool enable)
  5359. - void SetUseMutableGlyphs(bool enable)
  5360. - void SetForceAutoHint(bool enable)
  5361. - void SetScale(float scale)
  5362. - void SetWidth(float size)
  5363. - void SetHeight(float size)
  5364. - UIElement* GetRoot() const
  5365. - UIElement* GetRootModalElement() const
  5366. - Cursor* GetCursor() const
  5367. - IntVector2 GetCursorPosition() const
  5368. - UIElement* GetElementAt(const IntVector2& position, bool enabledOnly = true)
  5369. - UIElement* GetElementAt(int x, int y, bool enabledOnly = true)
  5370. - UIElement* GetFocusElement() const
  5371. - UIElement* GetFrontElement() const
  5372. - UIElement* GetDragElement(unsigned index)
  5373. - const String GetClipboardText() const
  5374. - float GetDoubleClickInterval() const
  5375. - float GetDragBeginInterval() const
  5376. - int GetDragBeginDistance() const
  5377. - float GetDefaultToolTipDelay() const
  5378. - int GetMaxFontTextureSize() const
  5379. - bool IsNonFocusedMouseWheel() const
  5380. - bool GetUseSystemClipboard() const
  5381. - bool GetUseScreenKeyboard() const
  5382. - bool GetUseMutableGlyphs() const
  5383. - bool GetForceAutoHint() const
  5384. - bool HasModalElement() const
  5385. - bool IsDragging() const
  5386. - float GetScale() const
  5387. Properties:
  5388. - UIElement* root (readonly)
  5389. - UIElement* rootModalElement (readonly)
  5390. - Cursor* cursor
  5391. - IntVector2 cursorPosition (readonly)
  5392. - UIElement* focusElement (readonly)
  5393. - UIElement* frontElement (readonly)
  5394. - String clipboardText
  5395. - float doubleClickInterval
  5396. - float dragBeginInterval
  5397. - int dragBeginDistance
  5398. - float defaultToolTipDelay
  5399. - int maxFontTextureSize
  5400. - bool nonFocusedMouseWheel
  5401. - bool useSystemClipboard
  5402. - bool useScreenKeyboard
  5403. - bool useMutableGlyphs
  5404. - bool forceAutoHint
  5405. - bool modalElement (readonly)
  5406. - float scale
  5407. <a name="Class_UIElement"></a>
  5408. ### UIElement : Animatable
  5409. Methods:
  5410. - UIElement() (GC)
  5411. - UIElement* new()
  5412. - void delete()
  5413. - const IntVector2& GetScreenPosition() const
  5414. - bool LoadXML(Deserializer& source)
  5415. - bool SaveXML(Serializer& dest, const String indentation = "\t") const
  5416. - bool LoadXML(const String fileName)
  5417. - bool SaveXML(const String fileName, const String indentation = "\t") const
  5418. - bool FilterAttributes(XMLElement& dest) const
  5419. - void SetName(const String name)
  5420. - void SetPosition(const IntVector2& position)
  5421. - void SetPosition(int x, int y)
  5422. - void SetSize(const IntVector2& size)
  5423. - void SetSize(int width, int height)
  5424. - void SetWidth(int width)
  5425. - void SetHeight(int height)
  5426. - void SetMinSize(const IntVector2& minSize)
  5427. - void SetMinSize(int width, int height)
  5428. - void SetMinWidth(int width)
  5429. - void SetMinHeight(int height)
  5430. - void SetMaxSize(const IntVector2& maxSize)
  5431. - void SetMaxSize(int width, int height)
  5432. - void SetMaxWidth(int width)
  5433. - void SetMaxHeight(int height)
  5434. - void SetFixedSize(const IntVector2& size)
  5435. - void SetFixedSize(int width, int height)
  5436. - void SetFixedWidth(int width)
  5437. - void SetFixedHeight(int height)
  5438. - void SetAlignment(HorizontalAlignment hAlign, VerticalAlignment vAlign)
  5439. - void SetHorizontalAlignment(HorizontalAlignment align)
  5440. - void SetVerticalAlignment(VerticalAlignment align)
  5441. - void SetClipBorder(const IntRect& rect)
  5442. - void SetColor(const Color& color)
  5443. - void SetColor(Corner corner, const Color& color)
  5444. - void SetPriority(int priority)
  5445. - void SetOpacity(float opacity)
  5446. - void SetBringToFront(bool enable)
  5447. - void SetBringToBack(bool enable)
  5448. - void SetClipChildren(bool enable)
  5449. - void SetSortChildren(bool enable)
  5450. - void SetUseDerivedOpacity(bool enable)
  5451. - void SetEnabled(bool enable)
  5452. - void SetDeepEnabled(bool enable)
  5453. - void ResetDeepEnabled()
  5454. - void SetEnabledRecursive(bool enable)
  5455. - void SetEditable(bool enable)
  5456. - void SetFocus(bool enable)
  5457. - void SetSelected(bool enable)
  5458. - void SetVisible(bool enable)
  5459. - void SetFocusMode(FocusMode mode)
  5460. - void SetDragDropMode(unsigned mode)
  5461. - bool SetStyle(const String styleName, XMLFile* file = 0)
  5462. - bool SetStyle(const XMLElement& element)
  5463. - bool SetStyleAuto(XMLFile* file = 0)
  5464. - void SetDefaultStyle(XMLFile* style)
  5465. - void SetLayout(LayoutMode mode, int spacing = 0)
  5466. - void SetLayout(LayoutMode mode, int spacing, const IntRect& border)
  5467. - void SetLayoutMode(LayoutMode mode)
  5468. - void SetLayoutSpacing(int spacing)
  5469. - void SetLayoutBorder(const IntRect& border)
  5470. - void SetLayoutFlexScale(const Vector2& scale)
  5471. - void SetIndent(int indent)
  5472. - void SetIndentSpacing(int indentSpacing)
  5473. - void UpdateLayout()
  5474. - void DisableLayoutUpdate()
  5475. - void EnableLayoutUpdate()
  5476. - void BringToFront()
  5477. - UIElement* CreateChild(const String type, const String name = String::EMPTY, unsigned index = M_MAX_UNSIGNED)
  5478. - void AddChild(UIElement* element)
  5479. - void InsertChild(unsigned index, UIElement* element)
  5480. - void RemoveChild(UIElement* element, unsigned index = 0)
  5481. - void RemoveChildAtIndex(unsigned index)
  5482. - void RemoveAllChildren()
  5483. - void Remove()
  5484. - unsigned FindChild(UIElement* element) const
  5485. - void SetParent(UIElement* parent, unsigned index = M_MAX_UNSIGNED)
  5486. - void SetVar(StringHash key, const Variant& value)
  5487. - void SetInternal(bool enable)
  5488. - void SetTraversalMode(TraversalMode traversalMode)
  5489. - void SetElementEventSender(bool flag)
  5490. - const String GetName() const
  5491. - const IntVector2& GetPosition() const
  5492. - const IntVector2& GetSize() const
  5493. - int GetWidth() const
  5494. - int GetHeight() const
  5495. - const IntVector2& GetMinSize() const
  5496. - int GetMinWidth() const
  5497. - int GetMinHeight() const
  5498. - const IntVector2& GetMaxSize() const
  5499. - int GetMaxWidth() const
  5500. - int GetMaxHeight() const
  5501. - bool IsFixedSize() const
  5502. - bool IsFixedWidth() const
  5503. - bool IsFixedHeight() const
  5504. - const IntVector2& GetChildOffset() const
  5505. - HorizontalAlignment GetHorizontalAlignment() const
  5506. - VerticalAlignment GetVerticalAlignment() const
  5507. - const IntRect& GetClipBorder() const
  5508. - const Color& GetColor(Corner corner) const
  5509. - int GetPriority() const
  5510. - float GetOpacity() const
  5511. - float GetDerivedOpacity() const
  5512. - bool GetBringToFront() const
  5513. - bool GetBringToBack() const
  5514. - bool GetClipChildren() const
  5515. - bool GetSortChildren() const
  5516. - bool GetUseDerivedOpacity() const
  5517. - bool HasFocus() const
  5518. - bool IsEnabled() const
  5519. - bool IsEnabledSelf() const
  5520. - bool IsEditable() const
  5521. - bool IsSelected() const
  5522. - bool IsVisible() const
  5523. - bool IsVisibleEffective() const
  5524. - bool IsHovering() const
  5525. - bool IsInternal() const
  5526. - bool HasColorGradient() const
  5527. - FocusMode GetFocusMode() const
  5528. - unsigned GetDragDropMode() const
  5529. - const String GetAppliedStyle() const
  5530. - XMLFile* GetDefaultStyle(bool recursiveUp = true) const
  5531. - LayoutMode GetLayoutMode() const
  5532. - int GetLayoutSpacing() const
  5533. - const IntRect& GetLayoutBorder() const
  5534. - const Vector2& GetLayoutFlexScale() const
  5535. - unsigned GetNumChildren(bool recursive = false) const
  5536. - int GetDragButtonCombo() const
  5537. - unsigned GetDragButtonCount() const
  5538. - UIElement* GetChild(const String name, bool recursive = false) const
  5539. - UIElement* GetChild(unsigned index) const
  5540. - UIElement* GetParent() const
  5541. - UIElement* GetRoot() const
  5542. - const Color& GetDerivedColor() const
  5543. - const Variant& GetVar(StringHash key) const
  5544. - const VariantMap& GetVars() const
  5545. - IntVector2 ScreenToElement(const IntVector2& screenPosition)
  5546. - IntVector2 ElementToScreen(const IntVector2& position)
  5547. - bool IsInside(IntVector2 position, bool isScreen)
  5548. - bool IsInsideCombined(IntVector2 position, bool isScreen)
  5549. - IntRect GetCombinedScreenRect()
  5550. - void SortChildren()
  5551. - int GetIndent() const
  5552. - int GetIndentSpacing() const
  5553. - int GetIndentWidth() const
  5554. - void SetChildOffset(const IntVector2& offset)
  5555. - void SetHovering(bool enable)
  5556. - const Color& GetColor() const
  5557. - TraversalMode GetTraversalMode() const
  5558. - bool IsElementEventSender() const
  5559. - UIElement* GetElementEventSender() const
  5560. Properties:
  5561. - IntVector2& screenPosition (readonly)
  5562. - String name
  5563. - IntVector2& position
  5564. - IntVector2 size
  5565. - int width
  5566. - int height
  5567. - IntVector2 minSize
  5568. - int minWidth
  5569. - int minHeight
  5570. - IntVector2 maxSize
  5571. - int maxWidth
  5572. - int maxHeight
  5573. - bool fixedSize (readonly)
  5574. - bool fixedWidth (readonly)
  5575. - bool fixedHeight (readonly)
  5576. - IntVector2& childOffset
  5577. - HorizontalAlignment horizontalAlignment
  5578. - VerticalAlignment verticalAlignment
  5579. - IntRect clipBorder
  5580. - Color& color
  5581. - int priority
  5582. - float opacity
  5583. - float derivedOpacity (readonly)
  5584. - bool bringToFront
  5585. - bool bringToBack
  5586. - bool clipChildren
  5587. - bool sortChildren
  5588. - bool useDerivedOpacity
  5589. - bool focus
  5590. - bool enabled
  5591. - bool enabledSelf (readonly)
  5592. - bool editable
  5593. - bool selected
  5594. - bool visible
  5595. - bool visibleEffective (readonly)
  5596. - bool hovering
  5597. - bool internal
  5598. - bool colorGradient (readonly)
  5599. - FocusMode focusMode
  5600. - unsigned dragDropMode
  5601. - String style
  5602. - XMLFile* defaultStyle
  5603. - LayoutMode layoutMode
  5604. - int layoutSpacing
  5605. - IntRect& layoutBorder
  5606. - Vector2& layoutFlexScale
  5607. - unsigned numChildren (readonly)
  5608. - UIElement* parent
  5609. - UIElement* root (readonly)
  5610. - Color& derivedColor (readonly)
  5611. - IntRect combinedScreenRect (readonly)
  5612. - int indent
  5613. - int indentSpacing
  5614. - int indentWidth (readonly)
  5615. - TraversalMode traversalMode
  5616. - bool elementEventSender
  5617. <a name="Class_ValueAnimation"></a>
  5618. ### ValueAnimation : Resource
  5619. Methods:
  5620. - ValueAnimation() (GC)
  5621. - ValueAnimation* new()
  5622. - void delete()
  5623. - void SetInterpolationMethod(InterpMethod method)
  5624. - void SetSplineTension(float tension)
  5625. - void SetValueType(VariantType valueType)
  5626. - bool SetKeyFrame(float time, const Variant& value)
  5627. - void SetEventFrame(float time, const StringHash& eventType)
  5628. - void SetEventFrame(float time, const StringHash& eventType, const VariantMap& eventData)
  5629. - InterpMethod GetInterpolationMethod() const
  5630. - float GetSplineTension() const
  5631. - VariantType GetValueType() const
  5632. Properties:
  5633. - InterpMethod interpolationMethod
  5634. - float splineTension
  5635. - VariantType valueType
  5636. <a name="Class_Variant"></a>
  5637. ### Variant
  5638. Methods:
  5639. - Variant() (GC)
  5640. - Variant* new()
  5641. - Variant(const Variant& value) (GC)
  5642. - Variant* new(const Variant& value)
  5643. - Variant(const char* type, const char* value) (GC)
  5644. - Variant* new(const char* type, const char* value)
  5645. - Variant(VariantType type, const char* value) (GC)
  5646. - Variant* new(VariantType type, const char* value)
  5647. - void delete()
  5648. - void Clear()
  5649. - bool operator==(const Variant& rhs) const
  5650. - void Set(const Variant& rhs)
  5651. - void* Get(const char* type = 0) const
  5652. - int GetInt() const
  5653. - unsigned GetUInt() const
  5654. - StringHash GetStringHash() const
  5655. - bool GetBool() const
  5656. - float GetFloat() const
  5657. - double GetDouble() const
  5658. - const Vector2& GetVector2() const
  5659. - const Vector3& GetVector3() const
  5660. - const Vector4& GetVector4() const
  5661. - const Quaternion& GetQuaternion() const
  5662. - const Color& GetColor() const
  5663. - const String GetString() const
  5664. - const PODVector<unsigned char>& GetRawBuffer() const
  5665. - const VectorBuffer GetBuffer() const
  5666. - void* GetVoidPtr(const char* type) const
  5667. - const ResourceRef& GetResourceRef() const
  5668. - const ResourceRefList& GetResourceRefList() const
  5669. - const Vector<Variant>& GetVariantVector() const
  5670. - const VariantMap& GetVariantMap() const
  5671. - const Vector<String>& GetStringVector() const
  5672. - const IntRect& GetIntRect() const
  5673. - const IntVector2& GetIntVector2() const
  5674. - RefCounted* GetPtr(const char* type) const
  5675. - const Matrix3& GetMatrix3() const
  5676. - const Matrix3x4& GetMatrix3x4() const
  5677. - const Matrix4& GetMatrix4() const
  5678. - VariantType GetType() const
  5679. - String GetTypeName() const
  5680. - String ToString() const
  5681. - bool IsZero() const
  5682. - bool IsEmpty() const
  5683. Properties:
  5684. - VariantType type (readonly)
  5685. - String typeName (readonly)
  5686. - bool zero (readonly)
  5687. - bool empty (readonly)
  5688. <a name="Class_VariantMap"></a>
  5689. ### VariantMap
  5690. Methods:
  5691. - VariantMap() (GC)
  5692. - VariantMap* new()
  5693. - void delete()
  5694. <a name="Class_Vector2"></a>
  5695. ### Vector2
  5696. Methods:
  5697. - Vector2() (GC)
  5698. - Vector2* new()
  5699. - Vector2(const Vector2& vector) (GC)
  5700. - Vector2* new(const Vector2& vector)
  5701. - Vector2(float x, float y) (GC)
  5702. - Vector2* new(float x, float y)
  5703. - void delete()
  5704. - bool operator==(const Vector2& rhs) const
  5705. - Vector2 operator+(const Vector2& rhs) const
  5706. - Vector2 operator-() const
  5707. - Vector2 operator-(const Vector2& rhs) const
  5708. - Vector2 operator*(float rhs) const
  5709. - Vector2 operator*(const Vector2& rhs) const
  5710. - Vector2 operator/(float rhs) const
  5711. - Vector2 operator/(const Vector2& rhs) const
  5712. - Vector2 operator/(const Vector2& rhs) const
  5713. - void Normalize()
  5714. - float Length() const
  5715. - float LengthSquared() const
  5716. - float DotProduct(const Vector2& rhs) const
  5717. - float AbsDotProduct(const Vector2& rhs) const
  5718. - Vector2 Abs() const
  5719. - Vector2 Lerp(const Vector2& rhs, float t) const
  5720. - bool Equals(const Vector2& rhs) const
  5721. - bool IsNaN() const
  5722. - Vector2 Normalized() const
  5723. - String ToString() const
  5724. Properties:
  5725. - float x
  5726. - float y
  5727. - const Vector2 ZERO
  5728. - const Vector2 LEFT
  5729. - const Vector2 RIGHT
  5730. - const Vector2 UP
  5731. - const Vector2 DOWN
  5732. - const Vector2 ONE
  5733. <a name="Class_Vector3"></a>
  5734. ### Vector3
  5735. Methods:
  5736. - Vector3() (GC)
  5737. - Vector3* new()
  5738. - Vector3(const Vector3& vector) (GC)
  5739. - Vector3* new(const Vector3& vector)
  5740. - Vector3(const Vector2& vector, float z) (GC)
  5741. - Vector3* new(const Vector2& vector, float z)
  5742. - Vector3(const Vector2& vector) (GC)
  5743. - Vector3* new(const Vector2& vector)
  5744. - Vector3(float x, float y, float z) (GC)
  5745. - Vector3* new(float x, float y, float z)
  5746. - Vector3(float x, float y) (GC)
  5747. - Vector3* new(float x, float y)
  5748. - void delete()
  5749. - bool operator==(const Vector3& rhs) const
  5750. - Vector3 operator+(const Vector3& rhs) const
  5751. - Vector3 operator-() const
  5752. - Vector3 operator-(const Vector3& rhs) const
  5753. - Vector3 operator*(float rhs) const
  5754. - Vector3 operator*(const Vector3& rhs) const
  5755. - Vector3 operator/(float rhs) const
  5756. - Vector3 operator/(const Vector3& rhs) const
  5757. - void Normalize()
  5758. - float Length() const
  5759. - float LengthSquared() const
  5760. - float DotProduct(const Vector3& rhs) const
  5761. - float AbsDotProduct(const Vector3& rhs) const
  5762. - Vector3 CrossProduct(const Vector3& rhs) const
  5763. - Vector3 Abs() const
  5764. - Vector3 Lerp(const Vector3& rhs, float t) const
  5765. - bool Equals(const Vector3& rhs) const
  5766. - bool IsNaN() const
  5767. - float Angle(const Vector3& rhs) const
  5768. - Vector3 Normalized() const
  5769. - String ToString() const
  5770. Properties:
  5771. - float x
  5772. - float y
  5773. - float z
  5774. - const Vector3 ZERO
  5775. - const Vector3 LEFT
  5776. - const Vector3 RIGHT
  5777. - const Vector3 UP
  5778. - const Vector3 DOWN
  5779. - const Vector3 FORWARD
  5780. - const Vector3 BACK
  5781. - const Vector3 ONE
  5782. <a name="Class_Vector4"></a>
  5783. ### Vector4
  5784. Methods:
  5785. - Vector4() (GC)
  5786. - Vector4* new()
  5787. - Vector4(const Vector4& vector) (GC)
  5788. - Vector4* new(const Vector4& vector)
  5789. - Vector4(const Vector3& vector, float w) (GC)
  5790. - Vector4* new(const Vector3& vector, float w)
  5791. - Vector4(float x, float y, float z, float w) (GC)
  5792. - Vector4* new(float x, float y, float z, float w)
  5793. - void delete()
  5794. - bool operator==(const Vector4& rhs) const
  5795. - Vector4 operator+(const Vector4& rhs) const
  5796. - Vector4 operator-() const
  5797. - Vector4 operator-(const Vector4& rhs) const
  5798. - Vector4 operator*(float rhs) const
  5799. - Vector4 operator*(const Vector4& rhs) const
  5800. - Vector4 operator/(float rhs) const
  5801. - Vector4 operator/(const Vector4& rhs) const
  5802. - Vector4 operator/(const Vector4& rhs) const
  5803. - float DotProduct(const Vector4& rhs) const
  5804. - float AbsDotProduct(const Vector4& rhs) const
  5805. - Vector4 Abs() const
  5806. - Vector4 Lerp(const Vector4& rhs, float t) const
  5807. - bool Equals(const Vector4& rhs) const
  5808. - bool IsNaN() const
  5809. - String ToString() const
  5810. Properties:
  5811. - float x
  5812. - float y
  5813. - float z
  5814. - float w
  5815. - const Vector4 ZERO
  5816. - const Vector4 ONE
  5817. <a name="Class_VectorBuffer"></a>
  5818. ### VectorBuffer
  5819. Methods:
  5820. - VectorBuffer() (GC)
  5821. - VectorBuffer* new()
  5822. - VectorBuffer(Deserializer& source, unsigned size) (GC)
  5823. - VectorBuffer* new(Deserializer& source, unsigned size)
  5824. - void delete()
  5825. - void SetData(Deserializer& source, unsigned size)
  5826. - void Clear()
  5827. - void Resize(unsigned size)
  5828. - const void* GetData() const
  5829. - void* GetModifiableData()
  5830. - VectorBuffer Read(unsigned size)
  5831. - unsigned Seek(unsigned position)
  5832. - const String GetName() const
  5833. - unsigned GetChecksum()
  5834. - unsigned GetPosition() const
  5835. - unsigned GetSize() const
  5836. - bool IsEof() const
  5837. - int ReadInt()
  5838. - short ReadShort()
  5839. - char ReadByte()
  5840. - unsigned ReadUInt()
  5841. - short ReadUShort()
  5842. - char ReadUByte()
  5843. - bool ReadBool()
  5844. - float ReadFloat()
  5845. - double ReadDouble()
  5846. - IntRect ReadIntRect()
  5847. - IntVector2 ReadIntVector2()
  5848. - Rect ReadRect()
  5849. - Vector2 ReadVector2()
  5850. - Vector3 ReadVector3()
  5851. - Vector3 ReadPackedVector3(float maxAbsCoord)
  5852. - Vector4 ReadVector4()
  5853. - Quaternion ReadQuaternion()
  5854. - Quaternion ReadPackedQuaternion()
  5855. - Matrix3 ReadMatrix3()
  5856. - Matrix3x4 ReadMatrix3x4()
  5857. - Matrix4 ReadMatrix4()
  5858. - Color ReadColor()
  5859. - BoundingBox ReadBoundingBox()
  5860. - String ReadString()
  5861. - String ReadFileID()
  5862. - StringHash ReadStringHash()
  5863. - VectorBuffer ReadBuffer()
  5864. - ResourceRef ReadResourceRef()
  5865. - ResourceRefList ReadResourceRefList()
  5866. - Variant ReadVariant()
  5867. - Variant ReadVariant(VariantType type)
  5868. - VariantVector ReadVariantVector()
  5869. - VariantMap ReadVariantMap()
  5870. - unsigned ReadVLE()
  5871. - unsigned ReadNetID()
  5872. - String ReadLine()
  5873. - unsigned Write(const VectorBuffer& buffer)
  5874. - bool WriteInt(int value)
  5875. - bool WriteShort(short value)
  5876. - bool WriteByte(char value)
  5877. - bool WriteUInt(unsigned value)
  5878. - bool WriteUShort(short value)
  5879. - bool WriteUByte(char value)
  5880. - bool WriteBool(bool value)
  5881. - bool WriteFloat(float value)
  5882. - bool WriteDouble(double value)
  5883. - bool WriteIntRect(const IntRect& value)
  5884. - bool WriteIntVector2(const IntVector2& value)
  5885. - bool WriteRect(const Rect& value)
  5886. - bool WriteVector2(const Vector2& value)
  5887. - bool WriteVector3(const Vector3& value)
  5888. - bool WritePackedVector3(const Vector3& value, float maxAbsCoord)
  5889. - bool WriteVector4(const Vector4& value)
  5890. - bool WriteQuaternion(const Quaternion& value)
  5891. - bool WritePackedQuaternion(const Quaternion& value)
  5892. - bool WriteMatrix3(const Matrix3& value)
  5893. - bool WriteMatrix3x4(const Matrix3x4& value)
  5894. - bool WriteMatrix4(const Matrix4& value)
  5895. - bool WriteColor(const Color& value)
  5896. - bool WriteBoundingBox(const BoundingBox& value)
  5897. - bool WriteString(const String value)
  5898. - bool WriteFileID(const String value)
  5899. - bool WriteStringHash(const StringHash& value)
  5900. - bool WriteBuffer(const VectorBuffer& buffer)
  5901. - bool WriteResourceRef(const ResourceRef& value)
  5902. - bool WriteResourceRefList(const ResourceRefList& value)
  5903. - bool WriteVariant(const Variant& value)
  5904. - bool WriteVariantData(const Variant& value)
  5905. - bool WriteVariantVector(const VariantVector& value)
  5906. - bool WriteVariantMap(const VariantMap& value)
  5907. - bool WriteVLE(unsigned value)
  5908. - bool WriteNetID(unsigned value)
  5909. - bool WriteLine(const String value)
  5910. Properties:
  5911. - String name (readonly)
  5912. - unsigned checksum (readonly)
  5913. - unsigned position (readonly)
  5914. - unsigned size (readonly)
  5915. - bool eof (readonly)
  5916. <a name="Class_VertexBuffer"></a>
  5917. ### VertexBuffer : Object
  5918. Methods:
  5919. - VertexBuffer() (GC)
  5920. - VertexBuffer* new()
  5921. - void delete()
  5922. - void SetShadowed(bool enable)
  5923. - bool SetSize(unsigned vertexCount, unsigned elementMask, bool dynamic = false)
  5924. - bool SetData(VectorBuffer& data)
  5925. - bool SetDataRange(VectorBuffer& data, unsigned start, unsigned count, bool discard = false)
  5926. - VectorBuffer GetData()
  5927. - bool IsShadowed() const
  5928. - bool IsDynamic() const
  5929. - unsigned GetVertexCount() const
  5930. - unsigned GetVertexSize() const
  5931. - unsigned GetElementMask() const
  5932. Properties:
  5933. - bool shadowed
  5934. - bool dynamic (readonly)
  5935. - unsigned vertexCount (readonly)
  5936. - unsigned vertexSize (readonly)
  5937. - unsigned elementMask (readonly)
  5938. <a name="Class_View3D"></a>
  5939. ### View3D : Window
  5940. Methods:
  5941. - View3D() (GC)
  5942. - View3D* new()
  5943. - void delete()
  5944. - void SetView(Scene* scene, Camera* camera, bool ownScene = true)
  5945. - void SetFormat(unsigned format)
  5946. - void SetAutoUpdate(bool enable)
  5947. - void QueueUpdate()
  5948. - unsigned GetFormat() const
  5949. - bool GetAutoUpdate() const
  5950. - Scene* GetScene() const
  5951. - Node* GetCameraNode() const
  5952. - Texture2D* GetRenderTexture() const
  5953. - Texture2D* GetDepthTexture() const
  5954. - Viewport* GetViewport() const
  5955. Properties:
  5956. - unsigned format
  5957. - bool autoUpdate
  5958. <a name="Class_Viewport"></a>
  5959. ### Viewport
  5960. Methods:
  5961. - Viewport() (GC)
  5962. - Viewport* new()
  5963. - Viewport(Scene* scene, Camera* camera, RenderPath* renderPath = 0) (GC)
  5964. - Viewport* new(Scene* scene, Camera* camera, RenderPath* renderPath = 0)
  5965. - Viewport(Scene* scene, Camera* camera, const IntRect& rect, RenderPath* renderPath = 0) (GC)
  5966. - Viewport* new(Scene* scene, Camera* camera, const IntRect& rect, RenderPath* renderPath = 0)
  5967. - void delete()
  5968. - void SetScene(Scene* scene)
  5969. - void SetCamera(Camera* camera)
  5970. - void SetCullCamera(Camera* camera)
  5971. - void SetRect(const IntRect& rect)
  5972. - void SetRenderPath(RenderPath* path)
  5973. - void SetRenderPath(XMLFile* file)
  5974. - void SetDrawDebug(bool enable)
  5975. - Scene* GetScene() const
  5976. - Camera* GetCamera() const
  5977. - Camera* GetCullCamera() const
  5978. - const IntRect& GetRect() const
  5979. - RenderPath* GetRenderPath() const
  5980. - bool GetDrawDebug() const
  5981. - Ray GetScreenRay(int x, int y) const
  5982. - IntVector2 WorldToScreenPoint(const Vector3& worldPos) const
  5983. - Vector3 ScreenToWorldPoint(int x, int y, float depth) const
  5984. Properties:
  5985. - Scene* scene
  5986. - Camera* camera
  5987. - Camera* cullCamera
  5988. - IntRect& rect
  5989. - RenderPath* renderPath
  5990. - bool drawDebug
  5991. <a name="Class_Window"></a>
  5992. ### Window : BorderImage
  5993. Methods:
  5994. - Window() (GC)
  5995. - Window* new()
  5996. - void delete()
  5997. - void SetMovable(bool enable)
  5998. - void SetResizable(bool enable)
  5999. - void SetFixedWidthResizing(bool enable)
  6000. - void SetFixedHeightResizing(bool enable)
  6001. - void SetResizeBorder(const IntRect& rect)
  6002. - void SetModal(bool modal)
  6003. - void SetModalShadeColor(const Color& color)
  6004. - void SetModalFrameColor(const Color& color)
  6005. - void SetModalFrameSize(const IntVector2& size)
  6006. - void SetModalAutoDismiss(bool enable)
  6007. - bool IsMovable() const
  6008. - bool IsResizable() const
  6009. - bool GetFixedWidthResizing() const
  6010. - bool GetFixedHeightResizing() const
  6011. - const IntRect& GetResizeBorder() const
  6012. - bool IsModal() const
  6013. - const Color& GetModalShadeColor() const
  6014. - const Color& GetModalFrameColor() const
  6015. - const IntVector2& GetModalFrameSize() const
  6016. - bool GetModalAutoDismiss() const
  6017. Properties:
  6018. - bool movable
  6019. - bool resizable
  6020. - bool fixedWidthResizing
  6021. - bool fixedHeightResizing
  6022. - IntRect& resizeBorder
  6023. - bool modal
  6024. - Color& modalShadeColor
  6025. - Color& modalFrameColor
  6026. - IntVector2& modalFrameSize
  6027. - bool modalAutoDismiss
  6028. <a name="Class_XMLElement"></a>
  6029. ### XMLElement
  6030. Methods:
  6031. - XMLElement CreateChild(const String name)
  6032. - bool RemoveChild(const XMLElement& element)
  6033. - bool RemoveChild(const String name)
  6034. - bool RemoveChildren(const String name = String::EMPTY)
  6035. - bool RemoveAttribute(const String name = String::EMPTY)
  6036. - bool SetValue(const String value)
  6037. - bool SetAttribute(const String name, const String value)
  6038. - bool SetAttribute(const String value)
  6039. - bool SetBool(const String name, bool value)
  6040. - bool SetBoundingBox(const BoundingBox& value)
  6041. - bool SetColor(const String name, const Color& value)
  6042. - bool SetFloat(const String name, float value)
  6043. - bool SetDouble(const String name, double value)
  6044. - bool SetUInt(const String name, unsigned value)
  6045. - bool SetInt(const String name, int value)
  6046. - bool SetIntRect(const String name, const IntRect& value)
  6047. - bool SetIntVector2(const String name, const IntVector2& value)
  6048. - bool SetRect(const String name, const Rect& value)
  6049. - bool SetQuaternion(const String name, const Quaternion& value)
  6050. - bool SetString(const String name, const String value)
  6051. - bool SetVariant(const Variant& value)
  6052. - bool SetVariantValue(const Variant& value)
  6053. - bool SetResourceRef(const ResourceRef& value)
  6054. - bool SetResourceRefList(const ResourceRefList& value)
  6055. - bool SetVector2(const String name, const Vector2& value)
  6056. - bool SetVector3(const String name, const Vector3& value)
  6057. - bool SetVector4(const String name, const Vector4& value)
  6058. - bool SetVectorVariant(const String name, const Variant& value)
  6059. - bool SetMatrix3(const String name, const Matrix3& value)
  6060. - bool SetMatrix3x4(const String name, const Matrix3x4& value)
  6061. - bool SetMatrix4(const String name, const Matrix4& value)
  6062. - bool IsNull() const
  6063. - bool NotNull() const
  6064. - bool operatorbool() const
  6065. - String GetName() const
  6066. - bool HasChild(const String name) const
  6067. - XMLElement GetChild(const String name = String::EMPTY) const
  6068. - XMLElement GetNext(const String name = String::EMPTY) const
  6069. - XMLElement GetParent() const
  6070. - unsigned GetNumAttributes() const
  6071. - bool HasAttribute(const String name) const
  6072. - String GetValue() const
  6073. - String GetAttribute(const String name = String::EMPTY) const
  6074. - String GetAttributeLower(const String name) const
  6075. - String GetAttributeUpper(const String name) const
  6076. - Vector<String> GetAttributeNames() const
  6077. - bool GetBool(const String name) const
  6078. - BoundingBox GetBoundingBox() const
  6079. - Color GetColor(const String name) const
  6080. - float GetFloat(const String name) const
  6081. - double GetDouble(const String name) const
  6082. - unsigned GetUInt(const String name) const
  6083. - int GetInt(const String name) const
  6084. - IntRect GetIntRect(const String name) const
  6085. - IntVector2 GetIntVector2(const String name) const
  6086. - Rect GetRect(const String name) const
  6087. - Quaternion GetQuaternion(const String name) const
  6088. - Variant GetVariant() const
  6089. - Variant GetVariantValue(VariantType type) const
  6090. - ResourceRef GetResourceRef() const
  6091. - ResourceRefList GetResourceRefList() const
  6092. - VariantMap GetVariantMap() const
  6093. - Vector2 GetVector2(const String name) const
  6094. - Vector3 GetVector3(const String name) const
  6095. - Vector4 GetVector4(const String name) const
  6096. - Vector4 GetVector(const String name) const
  6097. - Matrix3 GetMatrix3(const String name) const
  6098. - Matrix3x4 GetMatrix3x4(const String name) const
  6099. - Matrix4 GetMatrix4(const String name) const
  6100. - XMLFile* GetFile() const
  6101. Properties:
  6102. - const XMLElement EMPTY
  6103. - bool null (readonly)
  6104. - String name (readonly)
  6105. - XMLElement parent (readonly)
  6106. - String value (readonly)
  6107. - unsigned numAttributes (readonly)
  6108. - XMLFile* file (readonly)
  6109. <a name="Class_XMLFile"></a>
  6110. ### XMLFile : Resource
  6111. Methods:
  6112. - XMLFile() (GC)
  6113. - XMLFile* new()
  6114. - void delete()
  6115. - bool FromString(const String source)
  6116. - XMLElement CreateRoot(const String name = String::EMPTY)
  6117. - XMLElement GetRoot(const String name = String::EMPTY)
  6118. - String ToString(const String indentation = "\t") const
  6119. - void Patch(XMLFile* patchFile)
  6120. - void Patch(XMLElement patchElement)
  6121. - bool Save(const String fileName, const String indentation = "\t") const
  6122. <a name="Class_Zone"></a>
  6123. ### Zone : Drawable
  6124. Methods:
  6125. - void SetBoundingBox(const BoundingBox& box)
  6126. - void SetAmbientColor(const Color& color)
  6127. - void SetFogColor(const Color& color)
  6128. - void SetFogStart(float start)
  6129. - void SetFogEnd(float end)
  6130. - void SetFogHeight(float height)
  6131. - void SetFogHeightScale(float scale)
  6132. - void SetPriority(int priority)
  6133. - void SetHeightFog(bool enable)
  6134. - void SetOverride(bool enable)
  6135. - void SetAmbientGradient(bool enable)
  6136. - void SetZoneTexture(Texture* texture)
  6137. - const Matrix3x4& GetInverseWorldTransform() const
  6138. - const Color& GetAmbientColor() const
  6139. - const Color& GetAmbientStartColor()
  6140. - const Color& GetAmbientEndColor()
  6141. - const Color& GetFogColor() const
  6142. - float GetFogStart() const
  6143. - float GetFogEnd() const
  6144. - float GetFogHeight() const
  6145. - float GetFogHeightScale() const
  6146. - int GetPriority() const
  6147. - bool GetHeightFog() const
  6148. - bool GetOverride() const
  6149. - bool GetAmbientGradient() const
  6150. - Texture* GetZoneTexture() const
  6151. - bool IsInside(const Vector3& point) const
  6152. Properties:
  6153. - BoundingBox& boundingBox
  6154. - Matrix3x4& inverseWorldTransform (readonly)
  6155. - Color& ambientColor
  6156. - Color& ambientStartColor (readonly)
  6157. - Color& ambientEndColor (readonly)
  6158. - Color& fogColor
  6159. - float fogStart
  6160. - float fogEnd
  6161. - float fogHeight
  6162. - float fogHeightScale
  6163. - int priority
  6164. - bool heightFog
  6165. - bool override
  6166. - bool ambientGradient
  6167. - Texture* zoneTexture
  6168. \section LuaScriptAPI_Enums Enumerations
  6169. ### BlendMode
  6170. - int BLEND_REPLACE
  6171. - int BLEND_ADD
  6172. - int BLEND_MULTIPLY
  6173. - int BLEND_ALPHA
  6174. - int BLEND_ADDALPHA
  6175. - int BLEND_PREMULALPHA
  6176. - int BLEND_INVDESTALPHA
  6177. - int BLEND_SUBTRACT
  6178. - int BLEND_SUBTRACTALPHA
  6179. - int MAX_BLENDMODES
  6180. ### BodyType2D
  6181. - int BT_STATIC
  6182. - int BT_KINEMATIC
  6183. - int BT_DYNAMIC
  6184. ### CollisionEventMode
  6185. - int COLLISION_NEVER
  6186. - int COLLISION_ACTIVE
  6187. - int COLLISION_ALWAYS
  6188. ### CompareMode
  6189. - int CMP_ALWAYS
  6190. - int CMP_EQUAL
  6191. - int CMP_NOTEQUAL
  6192. - int CMP_LESS
  6193. - int CMP_LESSEQUAL
  6194. - int CMP_GREATER
  6195. - int CMP_GREATEREQUAL
  6196. - int MAX_COMPAREMODES
  6197. ### CompressedFormat
  6198. - int CF_NONE
  6199. - int CF_RGBA
  6200. - int CF_DXT1
  6201. - int CF_DXT3
  6202. - int CF_DXT5
  6203. - int CF_ETC1
  6204. - int CF_PVRTC_RGB_2BPP
  6205. - int CF_PVRTC_RGBA_2BPP
  6206. - int CF_PVRTC_RGB_4BPP
  6207. - int CF_PVRTC_RGBA_4BPP
  6208. ### ConstraintType
  6209. - int CONSTRAINT_POINT
  6210. - int CONSTRAINT_HINGE
  6211. - int CONSTRAINT_SLIDER
  6212. - int CONSTRAINT_CONETWIST
  6213. ### Corner
  6214. - int C_TOPLEFT
  6215. - int C_TOPRIGHT
  6216. - int C_BOTTOMLEFT
  6217. - int C_BOTTOMRIGHT
  6218. - int MAX_UIELEMENT_CORNERS
  6219. ### CreateMode
  6220. - int REPLICATED
  6221. - int LOCAL
  6222. ### CrowdAgentRequestedTarget
  6223. - int CA_REQUESTEDTARGET_NONE
  6224. - int CA_REQUESTEDTARGET_POSITION
  6225. - int CA_REQUESTEDTARGET_VELOCITY
  6226. ### CrowdAgentState
  6227. - int CA_STATE_INVALID
  6228. - int CA_STATE_WALKING
  6229. - int CA_STATE_OFFMESH
  6230. ### CrowdAgentTargetState
  6231. - int CA_TARGET_NONE
  6232. - int CA_TARGET_FAILED
  6233. - int CA_TARGET_VALID
  6234. - int CA_TARGET_REQUESTING
  6235. - int CA_TARGET_WAITINGFORQUEUE
  6236. - int CA_TARGET_WAITINGFORPATH
  6237. - int CA_TARGET_VELOCITY
  6238. ### CubeMapFace
  6239. - int FACE_POSITIVE_X
  6240. - int FACE_NEGATIVE_X
  6241. - int FACE_POSITIVE_Y
  6242. - int FACE_NEGATIVE_Y
  6243. - int FACE_POSITIVE_Z
  6244. - int FACE_NEGATIVE_Z
  6245. - int MAX_CUBEMAP_FACES
  6246. ### CullMode
  6247. - int CULL_NONE
  6248. - int CULL_CCW
  6249. - int CULL_CW
  6250. - int MAX_CULLMODES
  6251. ### CursorShape
  6252. - int CS_NORMAL
  6253. - int CS_IBEAM
  6254. - int CS_CROSS
  6255. - int CS_RESIZEVERTICAL
  6256. - int CS_RESIZEDIAGONAL_TOPRIGHT
  6257. - int CS_RESIZEHORIZONTAL
  6258. - int CS_RESIZEDIAGONAL_TOPLEFT
  6259. - int CS_RESIZE_ALL
  6260. - int CS_ACCEPTDROP
  6261. - int CS_REJECTDROP
  6262. - int CS_BUSY
  6263. - int CS_BUSY_ARROW
  6264. - int CS_MAX_SHAPES
  6265. ### DBAPI
  6266. - int DBAPI_SQLITE
  6267. - int DBAPI_ODBC
  6268. ### EmitterType
  6269. - int EMITTER_SPHERE
  6270. - int EMITTER_BOX
  6271. ### EmitterType2D
  6272. - int EMITTER_TYPE_GRAVITY
  6273. - int EMITTER_TYPE_RADIAL
  6274. ### FaceCameraMode
  6275. - int FC_NONE
  6276. - int FC_ROTATE_XYZ
  6277. - int FC_ROTATE_Y
  6278. - int FC_LOOKAT_XYZ
  6279. - int FC_LOOKAT_Y
  6280. ### FaceCameraMode
  6281. - int FC_NONE
  6282. - int FC_ROTATE_XYZ
  6283. - int FC_ROTATE_Y
  6284. - int FC_LOOKAT_XYZ
  6285. - int FC_LOOKAT_Y
  6286. - int FC_DIRECTION
  6287. ### FileMode
  6288. - int FILE_READ
  6289. - int FILE_WRITE
  6290. - int FILE_READWRITE
  6291. ### FillMode
  6292. - int FILL_SOLID
  6293. - int FILL_WIREFRAME
  6294. - int FILL_POINT
  6295. ### FocusMode
  6296. - int FM_NOTFOCUSABLE
  6297. - int FM_RESETFOCUS
  6298. - int FM_FOCUSABLE
  6299. - int FM_FOCUSABLE_DEFOCUSABLE
  6300. ### FrustumPlane
  6301. - int PLANE_NEAR
  6302. - int PLANE_LEFT
  6303. - int PLANE_RIGHT
  6304. - int PLANE_UP
  6305. - int PLANE_DOWN
  6306. - int PLANE_FAR
  6307. ### GeometryType
  6308. - int GEOM_STATIC
  6309. - int GEOM_SKINNED
  6310. - int GEOM_INSTANCED
  6311. - int GEOM_BILLBOARD
  6312. - int GEOM_STATIC_NOINSTANCING
  6313. - int MAX_GEOMETRYTYPES
  6314. ### HighlightMode
  6315. - int HM_NEVER
  6316. - int HM_FOCUS
  6317. - int HM_ALWAYS
  6318. ### HorizontalAlignment
  6319. - int HA_LEFT
  6320. - int HA_CENTER
  6321. - int HA_RIGHT
  6322. ### HttpRequestState
  6323. - int HTTP_INITIALIZING
  6324. - int HTTP_ERROR
  6325. - int HTTP_OPEN
  6326. - int HTTP_CLOSED
  6327. ### InterpMethod
  6328. - int IM_LINEAR
  6329. - int IM_SPLINE
  6330. ### InterpolationMode
  6331. - int BEZIER_CURVE
  6332. - int CATMULL_ROM_CURVE
  6333. - int LINEAR_CURVE
  6334. - int CATMULL_ROM_FULL_CURVE
  6335. ### Intersection
  6336. - int OUTSIDE
  6337. - int INTERSECTS
  6338. - int INSIDE
  6339. ### JSONValueType
  6340. - int JSON_NULL
  6341. - int JSON_BOOL
  6342. - int JSON_NUMBER
  6343. - int JSON_STRING
  6344. - int JSON_ARRAY
  6345. - int JSON_OBJECT
  6346. ### LayoutMode
  6347. - int LM_FREE
  6348. - int LM_HORIZONTAL
  6349. - int LM_VERTICAL
  6350. ### LightType
  6351. - int LIGHT_DIRECTIONAL
  6352. - int LIGHT_SPOT
  6353. - int LIGHT_POINT
  6354. ### LoadMode
  6355. - int LOAD_RESOURCES_ONLY
  6356. - int LOAD_SCENE
  6357. - int LOAD_SCENE_AND_RESOURCES
  6358. ### LockState
  6359. - int LOCK_NONE
  6360. - int LOCK_HARDWARE
  6361. - int LOCK_SHADOW
  6362. - int LOCK_SCRATCH
  6363. ### LoopMode2D
  6364. - int LM_DEFAULT
  6365. - int LM_FORCE_LOOPED
  6366. - int LM_FORCE_CLAMPED
  6367. ### MouseMode
  6368. - int MM_ABSOLUTE
  6369. - int MM_RELATIVE
  6370. - int MM_WRAP
  6371. - int MM_FREE
  6372. ### NavigationPushiness
  6373. - int NAVIGATIONPUSHINESS_LOW
  6374. - int NAVIGATIONPUSHINESS_MEDIUM
  6375. - int NAVIGATIONPUSHINESS_HIGH
  6376. ### NavigationQuality
  6377. - int NAVIGATIONQUALITY_LOW
  6378. - int NAVIGATIONQUALITY_MEDIUM
  6379. - int NAVIGATIONQUALITY_HIGH
  6380. ### NavmeshPartitionType
  6381. - int NAVMESH_PARTITION_WATERSHED
  6382. - int NAVMESH_PARTITION_MONOTONE
  6383. ### Orientation
  6384. - int O_HORIZONTAL
  6385. - int O_VERTICAL
  6386. ### Orientation2D
  6387. - int O_ORTHOGONAL
  6388. - int O_ISOMETRIC
  6389. - int O_STAGGERED
  6390. ### PassLightingMode
  6391. - int LIGHTING_UNLIT
  6392. - int LIGHTING_PERVERTEX
  6393. - int LIGHTING_PERPIXEL
  6394. ### PrimitiveType
  6395. - int TRIANGLE_LIST
  6396. - int LINE_LIST
  6397. - int POINT_LIST
  6398. - int TRIANGLE_STRIP
  6399. - int LINE_STRIP
  6400. - int TRIANGLE_FAN
  6401. ### RayQueryLevel
  6402. - int RAY_AABB
  6403. - int RAY_OBB
  6404. - int RAY_TRIANGLE
  6405. - int RAY_TRIANGLE_UV
  6406. ### RenderCommandSortMode
  6407. - int SORT_FRONTTOBACK
  6408. - int SORT_BACKTOFRONT
  6409. ### RenderCommandType
  6410. - int CMD_NONE
  6411. - int CMD_CLEAR
  6412. - int CMD_SCENEPASS
  6413. - int CMD_QUAD
  6414. - int CMD_FORWARDLIGHTS
  6415. - int CMD_LIGHTVOLUMES
  6416. - int CMD_RENDERUI
  6417. ### RenderSurfaceUpdateMode
  6418. - int SURFACE_MANUALUPDATE
  6419. - int SURFACE_UPDATEVISIBLE
  6420. - int SURFACE_UPDATEALWAYS
  6421. ### RenderTargetSizeMode
  6422. - int SIZE_ABSOLUTE
  6423. - int SIZE_VIEWPORTDIVISOR
  6424. - int SIZE_VIEWPORTMULTIPLIER
  6425. ### ShaderType
  6426. - int VS
  6427. - int PS
  6428. ### ShadowQuality
  6429. - int SHADOWQUALITY_SIMPLE_16BIT
  6430. - int SHADOWQUALITY_SIMPLE_24BIT
  6431. - int SHADOWQUALITY_PCF_16BIT
  6432. - int SHADOWQUALITY_PCF_24BIT
  6433. - int SHADOWQUALITY_VSM
  6434. - int SHADOWQUALITY_BLUR_VSM
  6435. ### ShapeType
  6436. - int SHAPE_BOX
  6437. - int SHAPE_SPHERE
  6438. - int SHAPE_STATICPLANE
  6439. - int SHAPE_CYLINDER
  6440. - int SHAPE_CAPSULE
  6441. - int SHAPE_CONE
  6442. - int SHAPE_TRIANGLEMESH
  6443. - int SHAPE_CONVEXHULL
  6444. - int SHAPE_TERRAIN
  6445. ### StencilOp
  6446. - int OP_KEEP
  6447. - int OP_ZERO
  6448. - int OP_REF
  6449. - int OP_INCR
  6450. - int OP_DECR
  6451. ### TextEffect
  6452. - int TE_NONE
  6453. - int TE_SHADOW
  6454. - int TE_STROKE
  6455. ### TextureAddressMode
  6456. - int ADDRESS_WRAP
  6457. - int ADDRESS_MIRROR
  6458. - int ADDRESS_CLAMP
  6459. - int ADDRESS_BORDER
  6460. - int MAX_ADDRESSMODES
  6461. ### TextureCoordinate
  6462. - int COORD_U
  6463. - int COORD_V
  6464. - int COORD_W
  6465. - int MAX_COORDS
  6466. ### TextureFilterMode
  6467. - int FILTER_NEAREST
  6468. - int FILTER_BILINEAR
  6469. - int FILTER_TRILINEAR
  6470. - int FILTER_ANISOTROPIC
  6471. - int FILTER_DEFAULT
  6472. - int MAX_FILTERMODES
  6473. ### TextureUnit
  6474. - int TU_DIFFUSE
  6475. - int TU_ALBEDOBUFFER
  6476. - int TU_NORMAL
  6477. - int TU_NORMALBUFFER
  6478. - int TU_SPECULAR
  6479. - int TU_EMISSIVE
  6480. - int TU_ENVIRONMENT
  6481. ### TextureUsage
  6482. - int TEXTURE_STATIC
  6483. - int TEXTURE_DYNAMIC
  6484. - int TEXTURE_RENDERTARGET
  6485. - int TEXTURE_DEPTHSTENCIL
  6486. ### TileMapLayerType2D
  6487. - int LT_TILE_LAYER
  6488. - int LT_OBJECT_GROUP
  6489. - int LT_IMAGE_LAYER
  6490. - int LT_INVALID
  6491. ### TileMapObjectType2D
  6492. - int OT_RECTANGLE
  6493. - int OT_ELLIPSE
  6494. - int OT_POLYGON
  6495. - int OT_POLYLINE
  6496. - int OT_TILE
  6497. - int OT_INVALID
  6498. ### TransformSpace
  6499. - int TS_LOCAL
  6500. - int TS_PARENT
  6501. - int TS_WORLD
  6502. ### TraversalMode
  6503. - int TM_BREADTH_FIRST
  6504. - int TM_DEPTH_FIRST
  6505. ### VariantType
  6506. - int VAR_NONE
  6507. - int VAR_INT
  6508. - int VAR_BOOL
  6509. - int VAR_FLOAT
  6510. - int VAR_VECTOR2
  6511. - int VAR_VECTOR3
  6512. - int VAR_VECTOR4
  6513. - int VAR_QUATERNION
  6514. - int VAR_COLOR
  6515. - int VAR_STRING
  6516. - int VAR_BUFFER
  6517. - int VAR_VOIDPTR
  6518. - int VAR_RESOURCEREF
  6519. - int VAR_RESOURCEREFLIST
  6520. - int VAR_VARIANTVECTOR
  6521. - int VAR_VARIANTMAP
  6522. - int VAR_INTRECT
  6523. - int VAR_INTVECTOR2
  6524. - int VAR_PTR
  6525. - int VAR_MATRIX3
  6526. - int VAR_MATRIX3X4
  6527. - int VAR_MATRIX4
  6528. - int VAR_DOUBLE
  6529. - int VAR_STRINGVECTOR
  6530. - int MAX_VAR_TYPES
  6531. ### VertexElement
  6532. - int ELEMENT_POSITION
  6533. - int ELEMENT_NORMAL
  6534. - int ELEMENT_COLOR
  6535. - int ELEMENT_TEXCOORD1
  6536. - int ELEMENT_TEXCOORD2
  6537. - int ELEMENT_CUBETEXCOORD1
  6538. - int ELEMENT_CUBETEXCOORD2
  6539. - int ELEMENT_TANGENT
  6540. - int ELEMENT_BLENDWEIGHTS
  6541. - int ELEMENT_BLENDINDICES
  6542. - int ELEMENT_INSTANCEMATRIX1
  6543. - int ELEMENT_INSTANCEMATRIX2
  6544. - int ELEMENT_INSTANCEMATRIX3
  6545. - int ELEMENT_OBJECTINDEX
  6546. - int MAX_VERTEX_ELEMENTS
  6547. ### VerticalAlignment
  6548. - int VA_TOP
  6549. - int VA_CENTER
  6550. - int VA_BOTTOM
  6551. ### WindowDragMode
  6552. - int DRAG_NONE
  6553. - int DRAG_MOVE
  6554. - int DRAG_RESIZE_TOPLEFT
  6555. - int DRAG_RESIZE_TOP
  6556. - int DRAG_RESIZE_TOPRIGHT
  6557. - int DRAG_RESIZE_RIGHT
  6558. - int DRAG_RESIZE_BOTTOMRIGHT
  6559. - int DRAG_RESIZE_BOTTOM
  6560. - int DRAG_RESIZE_BOTTOMLEFT
  6561. - int DRAG_RESIZE_LEFT
  6562. ### WrapMode
  6563. - int WM_LOOP
  6564. - int WM_ONCE
  6565. - int WM_CLAMP
  6566. \section LuaScriptAPI_toluaFunctions tolua functions
  6567. - lua_usertype cast(lua_usertype object, const char* typename)
  6568. - lua_table getpeer(lua_userdata object)
  6569. - void inherit(lua_table table, lua_usertype c_instance)
  6570. - bool releaseownership(lua_usertype object)
  6571. - void setpeer(lua_userdata object, lua_table table)
  6572. - bool takeownership(lua_usertype object)
  6573. - const char* type(lua_object object)
  6574. \section LuaScriptAPI_GlobalFunctions Global functions
  6575. - float Abs(float value)
  6576. - int AbsInt(int value)
  6577. - float Acos(float x)
  6578. - String AddTrailingSlash(const String pathName)
  6579. - float Asin(float x)
  6580. - float Atan(float x)
  6581. - float Atan2(float y, float x)
  6582. - float Clamp(float value, float min, float max)
  6583. - int ClampInt(int value, int min, int max)
  6584. - VectorBuffer CompressVectorBuffer(VectorBuffer& src)
  6585. - float Cos(float angle)
  6586. - unsigned CountSetBits(unsigned value)
  6587. - VectorBuffer DecompressVectorBuffer(VectorBuffer& src)
  6588. - bool Equals(float lhs, float rhs)
  6589. - void ErrorDialog(const String title, const String message)
  6590. - void ErrorExit(const String message = String::EMPTY, int exitCode = EXIT_FAILURE)
  6591. - const Vector<String>& GetArguments()
  6592. - Audio* GetAudio()
  6593. - ResourceCache* GetCache()
  6594. - Console* GetConsole()
  6595. - String GetConsoleInput()
  6596. - Context* GetContext()
  6597. - DBAPI GetDBAPI()
  6598. - Database* GetDatabase()
  6599. - DebugHud* GetDebugHud()
  6600. - Engine* GetEngine()
  6601. - EventHandler* GetEventHandler() const
  6602. - Object* GetEventSender()
  6603. - bool GetExecuteConsoleCommands()
  6604. - String GetExtension(const String fullPath, bool lowercaseExtension = true)
  6605. - String GetFileName(const String fullPath)
  6606. - String GetFileNameAndExtension(const String fullPath, bool lowercaseExtension = false)
  6607. - String GetFileSizeString(long memorySize)
  6608. - FileSystem* GetFileSystem()
  6609. - Graphics* GetGraphics()
  6610. - Input* GetInput()
  6611. - String GetInternalPath(const String pathName)
  6612. - Localization* GetLocalization()
  6613. - Log* GetLog()
  6614. - String GetMiniDumpDir()
  6615. - String GetNativePath(const String pathName)
  6616. - Network* GetNetwork()
  6617. - unsigned GetNumLogicalCPUs()
  6618. - unsigned GetNumPhysicalCPUs()
  6619. - String GetParentPath(const String pathName)
  6620. - String GetPath(const String fullPath)
  6621. - String GetPlatform()
  6622. - unsigned GetRandomSeed()
  6623. - Renderer* GetRenderer()
  6624. - Time* GetTime()
  6625. - UI* GetUI()
  6626. - bool HasSubscribedToEvent(const String eventName)
  6627. - bool HasSubscribedToEvent(Object* sender, const String eventName)
  6628. - bool IsAbsolutePath(const String pathName)
  6629. - bool IsAlpha(unsigned ch)
  6630. - bool IsDigit(unsigned ch)
  6631. - bool IsNaN(float value)
  6632. - bool IsPowerOfTwo(unsigned value)
  6633. - float Lerp(float lhs, float rhs, float t)
  6634. - float Max(float lhs, float rhs)
  6635. - int MaxInt(int lhs, int rhs)
  6636. - float Min(float lhs, float rhs)
  6637. - int MinInt(int lhs, int rhs)
  6638. - unsigned NextPowerOfTwo(unsigned value)
  6639. - void OpenConsoleWindow()
  6640. - void PrintLine(const String str, bool error = false)
  6641. - int Rand()
  6642. - float RandStandardNormal()
  6643. - float Random()
  6644. - float Random(float min, float max)
  6645. - float Random(float range)
  6646. - int RandomInt(int min, int max)
  6647. - int RandomInt(int range)
  6648. - float RandomNormal(float meanValue, float variance)
  6649. - String RemoveTrailingSlash(const String pathName)
  6650. - String ReplaceExtension(const String fullPath, const String newExtension)
  6651. - unsigned SDBMHash(unsigned hash, char c)
  6652. - void SendEvent(const String eventName, VariantMap& eventData)
  6653. - void SetExecuteConsoleCommands(bool enable)
  6654. - void SetMiniDumpDir(const String pathName)
  6655. - void SetRandomSeed(unsigned seed)
  6656. - float Sign(float value)
  6657. - float Sin(float angle)
  6658. - float SmoothStep(float lhs, float rhs, float t)
  6659. - void SubscribeToEvent(const String eventName, void* functionOrFunctionName)
  6660. - void SubscribeToEvent(void* sender, const String eventName, void* functionOrFunctionName)
  6661. - float Tan(float angle)
  6662. - bool ToBool(const String source)
  6663. - Color ToColor(const String source)
  6664. - float ToFloat(const String source)
  6665. - int ToInt(const String source)
  6666. - IntRect ToIntRect(const String source)
  6667. - IntVector2 ToIntVector2(const String source)
  6668. - unsigned ToLower(unsigned ch)
  6669. - Matrix3 ToMatrix3(const String source)
  6670. - Matrix3x4 ToMatrix3x4(const String source)
  6671. - Matrix4 ToMatrix4(const String source)
  6672. - Quaternion ToQuaternion(const String source)
  6673. - Rect ToRect(const String source)
  6674. - String ToString(void* value)
  6675. - String ToStringHex(unsigned value)
  6676. - unsigned ToUInt(const String source)
  6677. - unsigned ToUpper(unsigned ch)
  6678. - Vector2 ToVector2(const String source)
  6679. - Vector3 ToVector3(const String source)
  6680. - Vector4 ToVector4(const String source, bool allowMissingCoords = false)
  6681. - void UnsubscribeFromAllEvents()
  6682. - void UnsubscribeFromAllEventsExcept(const Vector<String>& exceptionNames)
  6683. - void UnsubscribeFromEvent(Object* sender, const String eventName)
  6684. - void UnsubscribeFromEvent(const String eventName)
  6685. - void UnsubscribeFromEvents(Object* sender)
  6686. \section LuaScriptAPI_GlobalProperties Global properties
  6687. - Audio* audio (readonly)
  6688. - ResourceCache* cache (readonly)
  6689. - Console* console (readonly)
  6690. - Context* context (readonly)
  6691. - Database* database (readonly)
  6692. - DebugHud* debugHud (readonly)
  6693. - Engine* engine (readonly)
  6694. - EventHandler* eventHandler (readonly)
  6695. - EventSender* eventSender (readonly)
  6696. - FileSystem* fileSystem (readonly)
  6697. - Graphics* graphics (readonly)
  6698. - Input* input (readonly)
  6699. - Localization* localization (readonly)
  6700. - Log* log (readonly)
  6701. - Network* network (readonly)
  6702. - Renderer* renderer (readonly)
  6703. - Time* time (readonly)
  6704. - UI* ui (readonly)
  6705. \section LuaScriptAPI_GlobalConstants Global constants
  6706. - float ANIMATION_LOD_BASESCALE
  6707. - char CHANNEL_POSITION
  6708. - char CHANNEL_ROTATION
  6709. - char CHANNEL_SCALE
  6710. - unsigned CLEAR_COLOR
  6711. - unsigned CLEAR_DEPTH
  6712. - unsigned CLEAR_STENCIL
  6713. - int CONTROLLER_AXIS_LEFTX
  6714. - int CONTROLLER_AXIS_LEFTY
  6715. - int CONTROLLER_AXIS_RIGHTX
  6716. - int CONTROLLER_AXIS_RIGHTY
  6717. - int CONTROLLER_AXIS_TRIGGERLEFT
  6718. - int CONTROLLER_AXIS_TRIGGERRIGHT
  6719. - int CONTROLLER_BUTTON_A
  6720. - int CONTROLLER_BUTTON_B
  6721. - int CONTROLLER_BUTTON_BACK
  6722. - int CONTROLLER_BUTTON_DPAD_DOWN
  6723. - int CONTROLLER_BUTTON_DPAD_LEFT
  6724. - int CONTROLLER_BUTTON_DPAD_RIGHT
  6725. - int CONTROLLER_BUTTON_DPAD_UP
  6726. - int CONTROLLER_BUTTON_GUIDE
  6727. - int CONTROLLER_BUTTON_LEFTSHOULDER
  6728. - int CONTROLLER_BUTTON_LEFTSTICK
  6729. - int CONTROLLER_BUTTON_RIGHTSHOULDER
  6730. - int CONTROLLER_BUTTON_RIGHTSTICK
  6731. - int CONTROLLER_BUTTON_START
  6732. - int CONTROLLER_BUTTON_X
  6733. - int CONTROLLER_BUTTON_Y
  6734. - unsigned DD_DISABLED
  6735. - unsigned DD_SOURCE
  6736. - unsigned DD_SOURCE_AND_TARGET
  6737. - unsigned DD_TARGET
  6738. - unsigned DEBUGHUD_SHOW_ALL
  6739. - unsigned DEBUGHUD_SHOW_ALL_MEMORY
  6740. - unsigned DEBUGHUD_SHOW_MODE
  6741. - unsigned DEBUGHUD_SHOW_NONE
  6742. - unsigned DEBUGHUD_SHOW_PROFILER
  6743. - unsigned DEBUGHUD_SHOW_STATS
  6744. - unsigned DEFAULT_LIGHTMASK
  6745. - unsigned DEFAULT_SHADOWMASK
  6746. - unsigned DEFAULT_VIEWMASK
  6747. - unsigned DEFAULT_ZONEMASK
  6748. - unsigned DRAWABLE_ANY
  6749. - unsigned DRAWABLE_GEOMETRY
  6750. - unsigned DRAWABLE_GEOMETRY2D
  6751. - unsigned DRAWABLE_LIGHT
  6752. - unsigned DRAWABLE_ZONE
  6753. - unsigned FIRST_LOCAL_ID
  6754. - unsigned FIRST_REPLICATED_ID
  6755. - int HAT_CENTER
  6756. - int HAT_DOWN
  6757. - int HAT_LEFT
  6758. - int HAT_RIGHT
  6759. - int HAT_UP
  6760. - int KEY_0
  6761. - int KEY_1
  6762. - int KEY_2
  6763. - int KEY_3
  6764. - int KEY_4
  6765. - int KEY_5
  6766. - int KEY_6
  6767. - int KEY_7
  6768. - int KEY_8
  6769. - int KEY_9
  6770. - int KEY_A
  6771. - int KEY_ALT
  6772. - int KEY_APPLICATION
  6773. - int KEY_B
  6774. - int KEY_BACKSPACE
  6775. - int KEY_C
  6776. - int KEY_CAPSLOCK
  6777. - int KEY_CTRL
  6778. - int KEY_D
  6779. - int KEY_DELETE
  6780. - int KEY_DOWN
  6781. - int KEY_E
  6782. - int KEY_END
  6783. - int KEY_ESC
  6784. - int KEY_F
  6785. - int KEY_F1
  6786. - int KEY_F10
  6787. - int KEY_F11
  6788. - int KEY_F12
  6789. - int KEY_F13
  6790. - int KEY_F14
  6791. - int KEY_F15
  6792. - int KEY_F16
  6793. - int KEY_F17
  6794. - int KEY_F18
  6795. - int KEY_F19
  6796. - int KEY_F2
  6797. - int KEY_F20
  6798. - int KEY_F21
  6799. - int KEY_F22
  6800. - int KEY_F23
  6801. - int KEY_F24
  6802. - int KEY_F3
  6803. - int KEY_F4
  6804. - int KEY_F5
  6805. - int KEY_F6
  6806. - int KEY_F7
  6807. - int KEY_F8
  6808. - int KEY_F9
  6809. - int KEY_G
  6810. - int KEY_GUI
  6811. - int KEY_H
  6812. - int KEY_HOME
  6813. - int KEY_I
  6814. - int KEY_INSERT
  6815. - int KEY_J
  6816. - int KEY_K
  6817. - int KEY_KP_0
  6818. - int KEY_KP_1
  6819. - int KEY_KP_2
  6820. - int KEY_KP_3
  6821. - int KEY_KP_4
  6822. - int KEY_KP_5
  6823. - int KEY_KP_6
  6824. - int KEY_KP_7
  6825. - int KEY_KP_8
  6826. - int KEY_KP_9
  6827. - int KEY_KP_DIVIDE
  6828. - int KEY_KP_ENTER
  6829. - int KEY_KP_MINUS
  6830. - int KEY_KP_MULTIPLY
  6831. - int KEY_KP_PERIOD
  6832. - int KEY_KP_PLUS
  6833. - int KEY_L
  6834. - int KEY_LALT
  6835. - int KEY_LCTRL
  6836. - int KEY_LEFT
  6837. - int KEY_LGUI
  6838. - int KEY_LSHIFT
  6839. - int KEY_M
  6840. - int KEY_N
  6841. - int KEY_NUMLOCKCLEAR
  6842. - int KEY_O
  6843. - int KEY_P
  6844. - int KEY_PAGEDOWN
  6845. - int KEY_PAGEUP
  6846. - int KEY_PAUSE
  6847. - int KEY_PRINTSCREEN
  6848. - int KEY_Q
  6849. - int KEY_R
  6850. - int KEY_RALT
  6851. - int KEY_RCTRL
  6852. - int KEY_RETURN
  6853. - int KEY_RETURN2
  6854. - int KEY_RGUI
  6855. - int KEY_RIGHT
  6856. - int KEY_RSHIFT
  6857. - int KEY_S
  6858. - int KEY_SCROLLLOCK
  6859. - int KEY_SELECT
  6860. - int KEY_SHIFT
  6861. - int KEY_SPACE
  6862. - int KEY_T
  6863. - int KEY_TAB
  6864. - int KEY_U
  6865. - int KEY_UP
  6866. - int KEY_V
  6867. - int KEY_W
  6868. - int KEY_X
  6869. - int KEY_Y
  6870. - int KEY_Z
  6871. - unsigned LAST_LOCAL_ID
  6872. - unsigned LAST_REPLICATED_ID
  6873. - int LOG_DEBUG
  6874. - int LOG_ERROR
  6875. - int LOG_INFO
  6876. - int LOG_NONE
  6877. - int LOG_WARNING
  6878. - unsigned MASK_BLENDINDICES
  6879. - unsigned MASK_BLENDWEIGHTS
  6880. - unsigned MASK_COLOR
  6881. - unsigned MASK_CUBETEXCOORD1
  6882. - unsigned MASK_CUBETEXCOORD2
  6883. - unsigned MASK_DEFAULT
  6884. - unsigned MASK_INSTANCEMATRIX1
  6885. - unsigned MASK_INSTANCEMATRIX2
  6886. - unsigned MASK_INSTANCEMATRIX3
  6887. - unsigned MASK_NONE
  6888. - unsigned MASK_NORMAL
  6889. - unsigned MASK_OBJECTINDEX
  6890. - unsigned MASK_POSITION
  6891. - unsigned MASK_TANGENT
  6892. - unsigned MASK_TEXCOORD1
  6893. - unsigned MASK_TEXCOORD2
  6894. - int MAX_VERTEX_LIGHTS
  6895. - int MOUSEB_LEFT
  6896. - int MOUSEB_MIDDLE
  6897. - int MOUSEB_RIGHT
  6898. - float M_DEGTORAD
  6899. - float M_DEGTORAD_2
  6900. - float M_EPSILON
  6901. - float M_HALF_PI
  6902. - float M_INFINITY
  6903. - float M_LARGE_EPSILON
  6904. - float M_LARGE_VALUE
  6905. - float M_MAX_FOV
  6906. - int M_MAX_INT
  6907. - unsigned M_MAX_UNSIGNED
  6908. - int M_MIN_INT
  6909. - float M_MIN_NEARCLIP
  6910. - unsigned M_MIN_UNSIGNED
  6911. - float M_PI
  6912. - float M_RADTODEG
  6913. - unsigned NUM_FRUSTUM_PLANES
  6914. - unsigned NUM_FRUSTUM_VERTICES
  6915. - float PIXEL_SIZE
  6916. - int QUALITY_HIGH
  6917. - int QUALITY_LOW
  6918. - int QUALITY_MAX
  6919. - int QUALITY_MEDIUM
  6920. - int QUAL_ALT
  6921. - int QUAL_ANY
  6922. - int QUAL_CTRL
  6923. - int QUAL_SHIFT
  6924. - int SCANCODE_0
  6925. - int SCANCODE_1
  6926. - int SCANCODE_2
  6927. - int SCANCODE_3
  6928. - int SCANCODE_4
  6929. - int SCANCODE_5
  6930. - int SCANCODE_6
  6931. - int SCANCODE_7
  6932. - int SCANCODE_8
  6933. - int SCANCODE_9
  6934. - int SCANCODE_A
  6935. - int SCANCODE_AC_BACK
  6936. - int SCANCODE_AC_BOOKMARKS
  6937. - int SCANCODE_AC_FORWARD
  6938. - int SCANCODE_AC_HOME
  6939. - int SCANCODE_AC_REFRESH
  6940. - int SCANCODE_AC_SEARCH
  6941. - int SCANCODE_AC_STOP
  6942. - int SCANCODE_AGAIN
  6943. - int SCANCODE_ALT
  6944. - int SCANCODE_ALTERASE
  6945. - int SCANCODE_APOSTROPHE
  6946. - int SCANCODE_APP1
  6947. - int SCANCODE_APP2
  6948. - int SCANCODE_APPLICATION
  6949. - int SCANCODE_AUDIOMUTE
  6950. - int SCANCODE_AUDIONEXT
  6951. - int SCANCODE_AUDIOPLAY
  6952. - int SCANCODE_AUDIOPREV
  6953. - int SCANCODE_AUDIOSTOP
  6954. - int SCANCODE_B
  6955. - int SCANCODE_BACKSLASH
  6956. - int SCANCODE_BACKSPACE
  6957. - int SCANCODE_BRIGHTNESSDOWN
  6958. - int SCANCODE_BRIGHTNESSUP
  6959. - int SCANCODE_C
  6960. - int SCANCODE_CALCULATOR
  6961. - int SCANCODE_CANCEL
  6962. - int SCANCODE_CAPSLOCK
  6963. - int SCANCODE_CLEAR
  6964. - int SCANCODE_CLEARAGAIN
  6965. - int SCANCODE_COMMA
  6966. - int SCANCODE_COMPUTER
  6967. - int SCANCODE_COPY
  6968. - int SCANCODE_CRSEL
  6969. - int SCANCODE_CTRL
  6970. - int SCANCODE_CURRENCYSUBUNIT
  6971. - int SCANCODE_CURRENCYUNIT
  6972. - int SCANCODE_CUT
  6973. - int SCANCODE_D
  6974. - int SCANCODE_DECIMALSEPARATOR
  6975. - int SCANCODE_DELETE
  6976. - int SCANCODE_DISPLAYSWITCH
  6977. - int SCANCODE_DOWN
  6978. - int SCANCODE_E
  6979. - int SCANCODE_EJECT
  6980. - int SCANCODE_END
  6981. - int SCANCODE_EQUALS
  6982. - int SCANCODE_ESCAPE
  6983. - int SCANCODE_EXECUTE
  6984. - int SCANCODE_EXSEL
  6985. - int SCANCODE_F
  6986. - int SCANCODE_F1
  6987. - int SCANCODE_F10
  6988. - int SCANCODE_F11
  6989. - int SCANCODE_F12
  6990. - int SCANCODE_F13
  6991. - int SCANCODE_F14
  6992. - int SCANCODE_F15
  6993. - int SCANCODE_F16
  6994. - int SCANCODE_F17
  6995. - int SCANCODE_F18
  6996. - int SCANCODE_F19
  6997. - int SCANCODE_F2
  6998. - int SCANCODE_F20
  6999. - int SCANCODE_F21
  7000. - int SCANCODE_F22
  7001. - int SCANCODE_F23
  7002. - int SCANCODE_F24
  7003. - int SCANCODE_F3
  7004. - int SCANCODE_F4
  7005. - int SCANCODE_F5
  7006. - int SCANCODE_F6
  7007. - int SCANCODE_F7
  7008. - int SCANCODE_F8
  7009. - int SCANCODE_F9
  7010. - int SCANCODE_FIND
  7011. - int SCANCODE_G
  7012. - int SCANCODE_GRAVE
  7013. - int SCANCODE_GUI
  7014. - int SCANCODE_H
  7015. - int SCANCODE_HELP
  7016. - int SCANCODE_HOME
  7017. - int SCANCODE_I
  7018. - int SCANCODE_INSERT
  7019. - int SCANCODE_INTERNATIONAL1
  7020. - int SCANCODE_INTERNATIONAL2
  7021. - int SCANCODE_INTERNATIONAL3
  7022. - int SCANCODE_INTERNATIONAL4
  7023. - int SCANCODE_INTERNATIONAL5
  7024. - int SCANCODE_INTERNATIONAL6
  7025. - int SCANCODE_INTERNATIONAL7
  7026. - int SCANCODE_INTERNATIONAL8
  7027. - int SCANCODE_INTERNATIONAL9
  7028. - int SCANCODE_J
  7029. - int SCANCODE_K
  7030. - int SCANCODE_KBDILLUMDOWN
  7031. - int SCANCODE_KBDILLUMTOGGLE
  7032. - int SCANCODE_KBDILLUMUP
  7033. - int SCANCODE_KP_0
  7034. - int SCANCODE_KP_00
  7035. - int SCANCODE_KP_000
  7036. - int SCANCODE_KP_1
  7037. - int SCANCODE_KP_2
  7038. - int SCANCODE_KP_3
  7039. - int SCANCODE_KP_4
  7040. - int SCANCODE_KP_5
  7041. - int SCANCODE_KP_6
  7042. - int SCANCODE_KP_7
  7043. - int SCANCODE_KP_8
  7044. - int SCANCODE_KP_9
  7045. - int SCANCODE_KP_A
  7046. - int SCANCODE_KP_AMPERSAND
  7047. - int SCANCODE_KP_AT
  7048. - int SCANCODE_KP_B
  7049. - int SCANCODE_KP_BACKSPACE
  7050. - int SCANCODE_KP_BINARY
  7051. - int SCANCODE_KP_C
  7052. - int SCANCODE_KP_CLEAR
  7053. - int SCANCODE_KP_CLEARENTRY
  7054. - int SCANCODE_KP_COLON
  7055. - int SCANCODE_KP_COMMA
  7056. - int SCANCODE_KP_D
  7057. - int SCANCODE_KP_DBLAMPERSAND
  7058. - int SCANCODE_KP_DBLVERTICALBAR
  7059. - int SCANCODE_KP_DECIMAL
  7060. - int SCANCODE_KP_DIVIDE
  7061. - int SCANCODE_KP_E
  7062. - int SCANCODE_KP_ENTER
  7063. - int SCANCODE_KP_EQUALS
  7064. - int SCANCODE_KP_EQUALSAS400
  7065. - int SCANCODE_KP_EXCLAM
  7066. - int SCANCODE_KP_F
  7067. - int SCANCODE_KP_GREATER
  7068. - int SCANCODE_KP_HASH
  7069. - int SCANCODE_KP_HEXADECIMAL
  7070. - int SCANCODE_KP_LEFTBRACE
  7071. - int SCANCODE_KP_LEFTPAREN
  7072. - int SCANCODE_KP_LESS
  7073. - int SCANCODE_KP_MEMADD
  7074. - int SCANCODE_KP_MEMCLEAR
  7075. - int SCANCODE_KP_MEMDIVIDE
  7076. - int SCANCODE_KP_MEMMULTIPLY
  7077. - int SCANCODE_KP_MEMRECALL
  7078. - int SCANCODE_KP_MEMSTORE
  7079. - int SCANCODE_KP_MEMSUBTRACT
  7080. - int SCANCODE_KP_MINUS
  7081. - int SCANCODE_KP_MULTIPLY
  7082. - int SCANCODE_KP_OCTAL
  7083. - int SCANCODE_KP_PERCENT
  7084. - int SCANCODE_KP_PERIOD
  7085. - int SCANCODE_KP_PLUS
  7086. - int SCANCODE_KP_PLUSMINUS
  7087. - int SCANCODE_KP_POWER
  7088. - int SCANCODE_KP_RIGHTBRACE
  7089. - int SCANCODE_KP_RIGHTPAREN
  7090. - int SCANCODE_KP_SPACE
  7091. - int SCANCODE_KP_TAB
  7092. - int SCANCODE_KP_VERTICALBAR
  7093. - int SCANCODE_KP_XOR
  7094. - int SCANCODE_L
  7095. - int SCANCODE_LALT
  7096. - int SCANCODE_LANG1
  7097. - int SCANCODE_LANG2
  7098. - int SCANCODE_LANG3
  7099. - int SCANCODE_LANG4
  7100. - int SCANCODE_LANG5
  7101. - int SCANCODE_LANG6
  7102. - int SCANCODE_LANG7
  7103. - int SCANCODE_LANG8
  7104. - int SCANCODE_LANG9
  7105. - int SCANCODE_LCTRL
  7106. - int SCANCODE_LEFT
  7107. - int SCANCODE_LEFTBRACKET
  7108. - int SCANCODE_LGUI
  7109. - int SCANCODE_LSHIFT
  7110. - int SCANCODE_M
  7111. - int SCANCODE_MAIL
  7112. - int SCANCODE_MEDIASELECT
  7113. - int SCANCODE_MENU
  7114. - int SCANCODE_MINUS
  7115. - int SCANCODE_MODE
  7116. - int SCANCODE_MUTE
  7117. - int SCANCODE_N
  7118. - int SCANCODE_NONUSBACKSLASH
  7119. - int SCANCODE_NONUSHASH
  7120. - int SCANCODE_NUMLOCKCLEAR
  7121. - int SCANCODE_O
  7122. - int SCANCODE_OPER
  7123. - int SCANCODE_OUT
  7124. - int SCANCODE_P
  7125. - int SCANCODE_PAGEDOWN
  7126. - int SCANCODE_PAGEUP
  7127. - int SCANCODE_PASTE
  7128. - int SCANCODE_PAUSE
  7129. - int SCANCODE_PERIOD
  7130. - int SCANCODE_POWER
  7131. - int SCANCODE_PRINTSCREEN
  7132. - int SCANCODE_PRIOR
  7133. - int SCANCODE_Q
  7134. - int SCANCODE_R
  7135. - int SCANCODE_RALT
  7136. - int SCANCODE_RCTRL
  7137. - int SCANCODE_RETURN
  7138. - int SCANCODE_RETURN2
  7139. - int SCANCODE_RGUI
  7140. - int SCANCODE_RIGHT
  7141. - int SCANCODE_RIGHTBRACKET
  7142. - int SCANCODE_RSHIFT
  7143. - int SCANCODE_S
  7144. - int SCANCODE_SCROLLLOCK
  7145. - int SCANCODE_SELECT
  7146. - int SCANCODE_SEMICOLON
  7147. - int SCANCODE_SEPARATOR
  7148. - int SCANCODE_SHIFT
  7149. - int SCANCODE_SLASH
  7150. - int SCANCODE_SLEEP
  7151. - int SCANCODE_SPACE
  7152. - int SCANCODE_STOP
  7153. - int SCANCODE_SYSREQ
  7154. - int SCANCODE_T
  7155. - int SCANCODE_TAB
  7156. - int SCANCODE_THOUSANDSSEPARATOR
  7157. - int SCANCODE_U
  7158. - int SCANCODE_UNDO
  7159. - int SCANCODE_UNKNOWN
  7160. - int SCANCODE_UP
  7161. - int SCANCODE_V
  7162. - int SCANCODE_VOLUMEDOWN
  7163. - int SCANCODE_VOLUMEUP
  7164. - int SCANCODE_W
  7165. - int SCANCODE_WWW
  7166. - int SCANCODE_X
  7167. - int SCANCODE_Y
  7168. - int SCANCODE_Z
  7169. - unsigned SCAN_DIRS
  7170. - unsigned SCAN_FILES
  7171. - unsigned SCAN_HIDDEN
  7172. - String SOUND_AMBIENT
  7173. - String SOUND_EFFECT
  7174. - String SOUND_MASTER
  7175. - String SOUND_MUSIC
  7176. - String SOUND_VOICE
  7177. - unsigned VO_DISABLE_OCCLUSION
  7178. - unsigned VO_DISABLE_SHADOWS
  7179. - unsigned VO_LOW_MATERIAL_QUALITY
  7180. - unsigned VO_NONE
  7181. */
  7182. }