LuaScriptAPI.dox 245 KB

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