LuaScriptAPI.dox 268 KB

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