LuaScriptAPI.dox 259 KB

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