LuaScriptAPI.dox 220 KB

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