LuaScriptAPI.dox 275 KB

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