LuaScriptAPI.dox 273 KB

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