LuaScriptAPI.dox 259 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089
  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. - IntVector2 GetSize() const
  2197. - bool GetFullscreen() const
  2198. - bool GetResizable() const
  2199. - bool GetBorderless() const
  2200. - bool GetVSync() const
  2201. - bool GetTripleBuffer() const
  2202. - bool GetSRGB() const
  2203. - bool GetDither() const
  2204. - bool GetFlushGPU() const
  2205. - const String GetOrientations() const
  2206. - bool IsDeviceLost() const
  2207. - unsigned GetNumPrimitives() const
  2208. - unsigned GetNumBatches() const
  2209. - unsigned GetDummyColorFormat() const
  2210. - unsigned GetShadowMapFormat() const
  2211. - unsigned GetHiresShadowMapFormat() const
  2212. - bool GetInstancingSupport() const
  2213. - bool GetLightPrepassSupport() const
  2214. - bool GetDeferredSupport() const
  2215. - bool GetHardwareShadowSupport() const
  2216. - bool GetReadableDepthSupport() const
  2217. - bool GetSRGBSupport() const
  2218. - bool GetSRGBWriteSupport() const
  2219. - IntVector2 GetDesktopResolution() const
  2220. - const String GetShaderCacheDir() const
  2221. - unsigned GetAlphaFormat()
  2222. - unsigned GetLuminanceFormat()
  2223. - unsigned GetLuminanceAlphaFormat()
  2224. - unsigned GetRGBFormat()
  2225. - unsigned GetRGBAFormat()
  2226. - unsigned GetRGBA16Format()
  2227. - unsigned GetRGBAFloat16Format()
  2228. - unsigned GetRGBAFloat32Format()
  2229. - unsigned GetRG16Format()
  2230. - unsigned GetRGFloat16Format()
  2231. - unsigned GetRGFloat32Format()
  2232. - unsigned GetFloat16Format()
  2233. - unsigned GetFloat32Format()
  2234. - unsigned GetLinearDepthFormat()
  2235. - unsigned GetDepthStencilFormat()
  2236. - unsigned GetReadableDepthFormat()
  2237. - unsigned GetFormat(const String formatName)
  2238. - unsigned GetMaxBones()
  2239. Properties:
  2240. - bool initialized (readonly)
  2241. - String windowTitle
  2242. - String apiName (readonly)
  2243. - IntVector2 windowPosition
  2244. - int width (readonly)
  2245. - int height (readonly)
  2246. - int multiSample (readonly)
  2247. - IntVector2 size (readonly)
  2248. - bool fullscreen (readonly)
  2249. - bool resizable (readonly)
  2250. - bool borderless (readonly)
  2251. - bool vSync (readonly)
  2252. - bool tripleBuffer (readonly)
  2253. - bool sRGB
  2254. - bool dither
  2255. - bool flushGPU
  2256. - String orientations
  2257. - bool deviceLost (readonly)
  2258. - unsigned numPrimitives (readonly)
  2259. - unsigned numBatches (readonly)
  2260. - unsigned dummyColorFormat (readonly)
  2261. - unsigned shadowMapFormat (readonly)
  2262. - unsigned hiresShadowMapFormat (readonly)
  2263. - bool instancingSupport (readonly)
  2264. - bool lightPrepassSupport (readonly)
  2265. - bool deferredSupport (readonly)
  2266. - bool hardwareShadowSupport (readonly)
  2267. - bool readableDepthSupport (readonly)
  2268. - bool sRGBSupport (readonly)
  2269. - bool sRGBWriteSupport (readonly)
  2270. - IntVector2 desktopResolution (readonly)
  2271. - String shaderCacheDir
  2272. <a name="Class_HierarchyContainer"></a>
  2273. ### HierarchyContainer : UIElement
  2274. <a name="Class_HttpRequest"></a>
  2275. ### HttpRequest
  2276. Methods:
  2277. - const String GetURL() const
  2278. - const String GetVerb() const
  2279. - String GetError() const
  2280. - HttpRequestState GetState() const
  2281. - unsigned GetAvailableSize() const
  2282. - bool IsOpen() const
  2283. - VectorBuffer Read(unsigned size)
  2284. - bool IsEof() const
  2285. - int ReadInt()
  2286. - short ReadShort()
  2287. - char ReadByte()
  2288. - unsigned ReadUInt()
  2289. - short ReadUShort()
  2290. - char ReadUByte()
  2291. - bool ReadBool()
  2292. - float ReadFloat()
  2293. - double ReadDouble()
  2294. - IntRect ReadIntRect()
  2295. - IntVector2 ReadIntVector2()
  2296. - IntVector3 ReadIntVector3()
  2297. - Rect ReadRect()
  2298. - Vector2 ReadVector2()
  2299. - Vector3 ReadVector3()
  2300. - Vector3 ReadPackedVector3(float maxAbsCoord)
  2301. - Vector4 ReadVector4()
  2302. - Quaternion ReadQuaternion()
  2303. - Quaternion ReadPackedQuaternion()
  2304. - Matrix3 ReadMatrix3()
  2305. - Matrix3x4 ReadMatrix3x4()
  2306. - Matrix4 ReadMatrix4()
  2307. - Color ReadColor()
  2308. - BoundingBox ReadBoundingBox()
  2309. - String ReadString()
  2310. - String ReadFileID()
  2311. - StringHash ReadStringHash()
  2312. - VectorBuffer ReadBuffer()
  2313. - ResourceRef ReadResourceRef()
  2314. - ResourceRefList ReadResourceRefList()
  2315. - Variant ReadVariant()
  2316. - Variant ReadVariant(VariantType type)
  2317. - VariantVector ReadVariantVector()
  2318. - VariantMap ReadVariantMap()
  2319. - unsigned ReadVLE()
  2320. - unsigned ReadNetID()
  2321. - String ReadLine()
  2322. Properties:
  2323. - String URL (readonly)
  2324. - String verb (readonly)
  2325. - String error (readonly)
  2326. - HttpRequestState state (readonly)
  2327. - unsigned availableSize (readonly)
  2328. - bool open (readonly)
  2329. <a name="Class_Image"></a>
  2330. ### Image : Resource
  2331. Methods:
  2332. - Image() (GC)
  2333. - Image* new()
  2334. - void delete()
  2335. - bool SetSize(int width, int height, unsigned components)
  2336. - bool SetSize(int width, int height, int depth, unsigned components)
  2337. - void SetPixel(int x, int y, const Color& color)
  2338. - void SetPixel(int x, int y, int z, const Color& color)
  2339. - void SetPixelInt(int x, int y, unsigned uintColor)
  2340. - void SetPixelInt(int x, int y, int z, unsigned uintColor)
  2341. - bool LoadColorLUT(Deserializer& source)
  2342. - bool LoadColorLUT(const String fileName)
  2343. - bool FlipHorizontal()
  2344. - bool FlipVertical()
  2345. - bool Resize(int width, int height)
  2346. - void Clear(const Color& color)
  2347. - void ClearInt(unsigned uintColor)
  2348. - bool SaveBMP(const String fileName) const
  2349. - bool SavePNG(const String fileName) const
  2350. - bool SaveTGA(const String fileName) const
  2351. - bool SaveJPG(const String fileName, int quality) const
  2352. - bool SaveDDS(const String fileName) const
  2353. - Color GetPixel(int x, int y) const
  2354. - Color GetPixel(int x, int y, int z) const
  2355. - unsigned GetPixelInt(int x, int y) const
  2356. - unsigned GetPixelInt(int x, int y, int z) const
  2357. - Color GetPixelBilinear(float x, float y) const
  2358. - Color GetPixelTrilinear(float x, float y, float z) const
  2359. - int GetWidth() const
  2360. - int GetHeight() const
  2361. - int GetDepth() const
  2362. - unsigned GetComponents() const
  2363. - bool IsCompressed() const
  2364. - CompressedFormat GetCompressedFormat() const
  2365. - unsigned GetNumCompressedLevels() const
  2366. - Image* GetSubimage(const IntRect& rect) const
  2367. - bool IsCubemap() const
  2368. - bool IsArray() const
  2369. - bool IsSRGB() const
  2370. Properties:
  2371. - int width (readonly)
  2372. - int height (readonly)
  2373. - int depth (readonly)
  2374. - unsigned components (readonly)
  2375. - bool compressed (readonly)
  2376. - CompressedFormat compressedFormat (readonly)
  2377. - unsigned numCompressedLevels (readonly)
  2378. - bool cubemap (readonly)
  2379. - bool array (readonly)
  2380. - bool sRGB (readonly)
  2381. <a name="Class_IndexBuffer"></a>
  2382. ### IndexBuffer : Object
  2383. Methods:
  2384. - IndexBuffer() (GC)
  2385. - IndexBuffer* new()
  2386. - void delete()
  2387. - void SetShadowed(bool enable)
  2388. - bool SetSize(unsigned indexCount, bool largeIndices, bool dynamic = false)
  2389. - bool SetData(VectorBuffer& data)
  2390. - bool SetDataRange(VectorBuffer& data, unsigned start, unsigned count, bool discard = false)
  2391. - VectorBuffer GetData()
  2392. - bool IsShadowed() const
  2393. - bool IsDynamic() const
  2394. - unsigned GetIndexCount() const
  2395. - unsigned GetIndexSize() const
  2396. Properties:
  2397. - bool shadowed
  2398. - bool dynamic (readonly)
  2399. - unsigned indexCount (readonly)
  2400. - unsigned indexSize (readonly)
  2401. <a name="Class_Input"></a>
  2402. ### Input : Object
  2403. Methods:
  2404. - void SetToggleFullscreen(bool enable)
  2405. - void SetMouseVisible(bool enable, bool suppressEvent = false)
  2406. - void SetMouseGrabbed(bool grab, bool suppressEvent = false)
  2407. - void SetMouseMode(MouseMode mode, bool suppressEvent = false)
  2408. - bool IsMouseLocked()
  2409. - int AddScreenJoystick(XMLFile* layoutFile = 0, XMLFile* styleFile = 0)
  2410. - bool RemoveScreenJoystick(int id)
  2411. - void SetScreenJoystickVisible(int id, bool enable)
  2412. - void SetScreenKeyboardVisible(bool enable)
  2413. - void SetTouchEmulation(bool enable)
  2414. - bool RecordGesture()
  2415. - bool SaveGestures(File* dest)
  2416. - bool SaveGesture(File* dest, unsigned gestureID)
  2417. - unsigned LoadGestures(File* source)
  2418. - bool SaveGestures(const String fileName)
  2419. - bool SaveGesture(const String fileName, unsigned gestureID)
  2420. - unsigned LoadGestures(const String fileName)
  2421. - bool RemoveGesture(unsigned gestureID)
  2422. - void RemoveAllGestures()
  2423. - void SetMousePosition(const IntVector2& position)
  2424. - void CenterMousePosition()
  2425. - int GetKeyFromName(const String name) const
  2426. - int GetKeyFromScancode(int scancode) const
  2427. - String GetKeyName(int key) const
  2428. - int GetScancodeFromKey(int key) const
  2429. - int GetScancodeFromName(const String name) const
  2430. - String GetScancodeName(int scancode) const
  2431. - bool GetKeyDown(int key) const
  2432. - bool GetKeyPress(int key) const
  2433. - bool GetScancodeDown(int scancode) const
  2434. - bool GetScancodePress(int scancode) const
  2435. - bool GetMouseButtonDown(int button) const
  2436. - bool GetMouseButtonPress(int button) const
  2437. - bool GetQualifierDown(int qualifier) const
  2438. - bool GetQualifierPress(int qualifier) const
  2439. - int GetQualifiers() const
  2440. - IntVector2 GetMousePosition() const
  2441. - IntVector2 GetMouseMove() const
  2442. - int GetMouseMoveX() const
  2443. - int GetMouseMoveY() const
  2444. - int GetMouseMoveWheel() const
  2445. - unsigned GetNumTouches() const
  2446. - TouchState* GetTouch(unsigned index) const
  2447. - unsigned GetNumJoysticks() const
  2448. - JoystickState* GetJoystick(int id)
  2449. - JoystickState* GetJoystickByIndex(unsigned index)
  2450. - JoystickState* GetJoystickByName(const String name)
  2451. - bool GetToggleFullscreen() const
  2452. - bool GetScreenKeyboardSupport() const
  2453. - bool IsScreenJoystickVisible(int id) const
  2454. - bool IsScreenKeyboardVisible() const
  2455. - bool GetTouchEmulation() const
  2456. - bool IsMouseVisible() const
  2457. - bool IsMouseGrabbed() const
  2458. - MouseMode GetMouseMode() const
  2459. - bool HasFocus()
  2460. - bool IsMinimized() const
  2461. Properties:
  2462. - int qualifiers (readonly)
  2463. - IntVector2 mousePosition
  2464. - IntVector2 mouseMove (readonly)
  2465. - int mouseMoveX (readonly)
  2466. - int mouseMoveY (readonly)
  2467. - int mouseMoveWheel (readonly)
  2468. - unsigned numTouches (readonly)
  2469. - unsigned numJoysticks (readonly)
  2470. - bool toggleFullscreen (readonly)
  2471. - bool screenKeyboardSupport (readonly)
  2472. - MouseMode mouseMode
  2473. - bool screenKeyboardVisible
  2474. - bool touchEmulation
  2475. - bool mouseVisible
  2476. - bool mouseGrabbed
  2477. - bool mouseLocked (readonly)
  2478. - bool focus (readonly)
  2479. - bool minimized (readonly)
  2480. <a name="Class_IntRect"></a>
  2481. ### IntRect
  2482. Methods:
  2483. - IntRect() (GC)
  2484. - IntRect* new()
  2485. - IntRect(int left, int top, int right, int bottom) (GC)
  2486. - IntRect* new(int left, int top, int right, int bottom)
  2487. - void delete()
  2488. - bool operator==(const IntRect& rhs) const
  2489. - IntVector2 Size() const
  2490. - int Width() const
  2491. - int Height() const
  2492. - Intersection IsInside(const IntVector2& point) const
  2493. Properties:
  2494. - int left
  2495. - int top
  2496. - int right
  2497. - int bottom
  2498. - const IntRect ZERO
  2499. - IntVector2 size (readonly)
  2500. - int width (readonly)
  2501. - int height (readonly)
  2502. <a name="Class_IntVector2"></a>
  2503. ### IntVector2
  2504. Methods:
  2505. - IntVector2() (GC)
  2506. - IntVector2* new()
  2507. - IntVector2(int x, int y) (GC)
  2508. - IntVector2* new(int x, int y)
  2509. - IntVector2(const IntVector2& rhs) (GC)
  2510. - IntVector2* new(const IntVector2& rhs)
  2511. - void delete()
  2512. - bool operator==(const IntVector2& rhs) const
  2513. - IntVector2 operator+(const IntVector2& rhs) const
  2514. - IntVector2 operator-() const
  2515. - IntVector2 operator-(const IntVector2& rhs) const
  2516. - IntVector2 operator*(int rhs) const
  2517. - IntVector2 operator/(int rhs) const
  2518. - String ToString() const
  2519. - unsigned ToHash() const
  2520. - float Length() const
  2521. Properties:
  2522. - int x
  2523. - int y
  2524. - const IntVector2 ZERO
  2525. <a name="Class_IntVector3"></a>
  2526. ### IntVector3
  2527. Methods:
  2528. - IntVector3() (GC)
  2529. - IntVector3* new()
  2530. - IntVector3(int x, int y, int z) (GC)
  2531. - IntVector3* new(int x, int y, int z)
  2532. - IntVector3(const IntVector3& rhs) (GC)
  2533. - IntVector3* new(const IntVector3& rhs)
  2534. - void delete()
  2535. - bool operator==(const IntVector3& rhs) const
  2536. - IntVector3 operator+(const IntVector3& rhs) const
  2537. - IntVector3 operator-() const
  2538. - IntVector3 operator-(const IntVector3& rhs) const
  2539. - IntVector3 operator*(int rhs) const
  2540. - IntVector3 operator/(int rhs) const
  2541. - String ToString() const
  2542. - unsigned ToHash() const
  2543. - float Length() const
  2544. Properties:
  2545. - int x
  2546. - int y
  2547. - int z
  2548. - const IntVector3 ZERO
  2549. - const IntVector3 LEFT
  2550. - const IntVector3 RIGHT
  2551. - const IntVector3 UP
  2552. - const IntVector3 DOWN
  2553. - const IntVector3 FORWARD
  2554. - const IntVector3 BACK
  2555. - const IntVector3 ONE
  2556. <a name="Class_JSONFile"></a>
  2557. ### JSONFile : Resource
  2558. Methods:
  2559. - JSONFile() (GC)
  2560. - JSONFile* new()
  2561. - void delete()
  2562. - bool FromString(const String source)
  2563. - const JSONValue& GetRoot() const
  2564. - bool Save(const String fileName, const String indentation = "\t") const
  2565. <a name="Class_JSONValue"></a>
  2566. ### JSONValue
  2567. Methods:
  2568. - JSONValue() (GC)
  2569. - JSONValue* new()
  2570. - JSONValue(bool value) (GC)
  2571. - JSONValue* new(bool value)
  2572. - JSONValue(const char* value) (GC)
  2573. - JSONValue* new(const char* value)
  2574. - JSONValue(double value) (GC)
  2575. - JSONValue* new(double value)
  2576. - JSONValue(const JSONArray& value) (GC)
  2577. - JSONValue* new(const JSONArray& value)
  2578. - JSONValue(const JSONObject& value) (GC)
  2579. - JSONValue* new(const JSONObject& value)
  2580. - JSONValue(const JSONValue& value) (GC)
  2581. - JSONValue* new(const JSONValue& value)
  2582. - void delete()
  2583. - void SetBool(bool value)
  2584. - void SetInt(int value)
  2585. - void SetUint(unsigned value)
  2586. - void SetFloat(float value)
  2587. - void SetDouble(double value)
  2588. - void SetString(const String value)
  2589. - void SetArray(const JSONArray& value)
  2590. - void SetObject(const JSONObject& value)
  2591. - JSONValueType GetValueType() const
  2592. - JSONNumberType GetNumberType() const
  2593. - String GetValueTypeName() const
  2594. - String GetNumberTypeName() const
  2595. - bool IsNull() const
  2596. - bool IsBool() const
  2597. - bool IsNumber() const
  2598. - bool IsString() const
  2599. - bool IsArray() const
  2600. - bool IsObject() const
  2601. - bool GetBool() const
  2602. - int GetInt() const
  2603. - unsigned GetUInt() const
  2604. - float GetFloat() const
  2605. - double GetDouble() const
  2606. - const String GetString() const
  2607. - const JSONArray& GetArray() const
  2608. - const JSONObject& GetObject() const
  2609. - JSONValue operator&[](unsigned index, JSONValue tolua_value)
  2610. - JSONValue operator[](unsigned index)
  2611. - const JSONValue operator[](unsigned index) const
  2612. - void Push(const JSONValue& value)
  2613. - void Pop()
  2614. - void Insert(unsigned pos, const JSONValue& value)
  2615. - void Erase(unsigned pos, unsigned length = 1)
  2616. - void Resize(unsigned newSize)
  2617. - unsigned Size() const
  2618. - void Set(const String key, const JSONValue& value)
  2619. - const JSONValue& Get(const String key) const
  2620. - bool Erase(const String key)
  2621. - bool Contains(const String key) const
  2622. - void Clear()
  2623. Properties:
  2624. - const JSONValue EMPTY
  2625. - const JSONArray emptyArray
  2626. - const JSONObject emptyObject
  2627. - bool null (readonly)
  2628. - JSONValueType valueType (readonly)
  2629. - JSONNumberType numberType (readonly)
  2630. - String valueTypeName (readonly)
  2631. - String numberTypeName (readonly)
  2632. <a name="Class_JoystickState"></a>
  2633. ### JoystickState
  2634. Methods:
  2635. - bool IsController() const
  2636. - unsigned GetNumButtons() const
  2637. - unsigned GetNumAxes() const
  2638. - unsigned GetNumHats() const
  2639. - bool GetButtonDown(unsigned index) const
  2640. - bool GetButtonPress(unsigned index) const
  2641. - float GetAxisPosition(unsigned index) const
  2642. - int GetHatPosition(unsigned index) const
  2643. Properties:
  2644. - const String name
  2645. - const int joystickID
  2646. - bool controller (readonly)
  2647. - unsigned numButtons (readonly)
  2648. - unsigned numAxes (readonly)
  2649. - unsigned numHats (readonly)
  2650. <a name="Class_Light"></a>
  2651. ### Light : Drawable
  2652. Methods:
  2653. - void SetLightType(LightType type)
  2654. - void SetPerVertex(bool enable)
  2655. - void SetColor(const Color& color)
  2656. - void SetTemperature(float temperature)
  2657. - void SetRadius(float redius)
  2658. - void SetLength(float length)
  2659. - void SetUsePhysicalValues(bool enable)
  2660. - void SetSpecularIntensity(float intensity)
  2661. - void SetBrightness(float brightness)
  2662. - void SetRange(float range)
  2663. - void SetFov(float fov)
  2664. - void SetAspectRatio(float aspectRatio)
  2665. - void SetFadeDistance(float distance)
  2666. - void SetShadowFadeDistance(float distance)
  2667. - void SetShadowBias(const BiasParameters& parameters)
  2668. - void SetShadowCascade(const CascadeParameters& parameters)
  2669. - void SetShadowFocus(const FocusParameters& parameters)
  2670. - void SetShadowIntensity(float intensity)
  2671. - void SetShadowResolution(float resolution)
  2672. - void SetShadowNearFarRatio(float nearFarRatio)
  2673. - void SetShadowMaxExtrusion(float extrusion)
  2674. - void SetRampTexture(Texture* texture)
  2675. - void SetShapeTexture(Texture* texture)
  2676. - LightType GetLightType() const
  2677. - bool GetPerVertex() const
  2678. - const Color& GetColor() const
  2679. - float GetTemperature() const
  2680. - float GetRadius() const
  2681. - float GetLength() const
  2682. - float GetSpecularIntensity() const
  2683. - float GetBrightness() const
  2684. - Color GetEffectiveColor() const
  2685. - Color GetColorFromTemperature() const
  2686. - bool GetUsePhysicalValues() const
  2687. - float GetEffectiveSpecularIntensity() const
  2688. - float GetRange() const
  2689. - float GetFov() const
  2690. - float GetAspectRatio() const
  2691. - float GetFadeDistance() const
  2692. - float GetShadowFadeDistance() const
  2693. - const BiasParameters& GetShadowBias() const
  2694. - const CascadeParameters& GetShadowCascade() const
  2695. - const FocusParameters& GetShadowFocus() const
  2696. - float GetShadowIntensity() const
  2697. - float GetShadowResolution() const
  2698. - float GetShadowNearFarRatio() const
  2699. - float GetShadowMaxExtrusion() const
  2700. - Texture* GetRampTexture() const
  2701. - Texture* GetShapeTexture() const
  2702. - Frustum GetFrustum() const
  2703. - int GetNumShadowSplits() const
  2704. - bool IsNegative() const
  2705. Properties:
  2706. - LightType lightType
  2707. - bool perVertex
  2708. - Color& color
  2709. - float temperature
  2710. - float radius
  2711. - float length
  2712. - bool usePhysicalValues
  2713. - float specularIntensity
  2714. - float brightness
  2715. - float range
  2716. - float fov
  2717. - float aspectRatio
  2718. - float fadeDistance
  2719. - float shadowFadeDistance
  2720. - BiasParameters& shadowBias
  2721. - CascadeParameters& shadowCascade
  2722. - FocusParameters& shadowFocus
  2723. - float shadowIntensity
  2724. - float shadowResolution
  2725. - float shadowNearFarRatio
  2726. - float shadowMaxExtrusion
  2727. - Texture* rampTexture
  2728. - Texture* shapeTexture
  2729. - Frustum frustum (readonly)
  2730. - int numShadowSplits (readonly)
  2731. - bool negative (readonly)
  2732. - Color effectiveColor (readonly)
  2733. - float effectiveSpecularIntensity (readonly)
  2734. <a name="Class_LineEdit"></a>
  2735. ### LineEdit : BorderImage
  2736. Methods:
  2737. - LineEdit() (GC)
  2738. - LineEdit* new()
  2739. - void delete()
  2740. - void SetText(const String text)
  2741. - void SetCursorPosition(unsigned position)
  2742. - void SetCursorBlinkRate(float rate)
  2743. - void SetMaxLength(unsigned length)
  2744. - void SetEchoCharacter(unsigned c)
  2745. - void SetCursorMovable(bool enable)
  2746. - void SetTextSelectable(bool enable)
  2747. - void SetTextCopyable(bool enable)
  2748. - const String GetText() const
  2749. - unsigned GetCursorPosition() const
  2750. - float GetCursorBlinkRate() const
  2751. - unsigned GetMaxLength() const
  2752. - unsigned GetEchoCharacter() const
  2753. - bool IsCursorMovable() const
  2754. - bool IsTextSelectable() const
  2755. - bool IsTextCopyable() const
  2756. - Text* GetTextElement() const
  2757. - BorderImage* GetCursor() const
  2758. Properties:
  2759. - String text
  2760. - unsigned cursorPosition
  2761. - float cursorBlinkRate
  2762. - unsigned maxLength
  2763. - unsigned echoCharacter
  2764. - bool cursorMovable
  2765. - bool textSelectable
  2766. - bool textCopyable
  2767. - Text* textElement (readonly)
  2768. - BorderImage* cursor (readonly)
  2769. <a name="Class_ListView"></a>
  2770. ### ListView : ScrollView
  2771. Methods:
  2772. - ListView() (GC)
  2773. - ListView* new()
  2774. - void delete()
  2775. - void AddItem(UIElement* item)
  2776. - void InsertItem(unsigned index, UIElement* item, UIElement* parentItem = 0)
  2777. - void RemoveItem(UIElement* item, unsigned index = 0)
  2778. - void RemoveItem(unsigned index)
  2779. - void RemoveAllItems()
  2780. - void SetSelection(unsigned index)
  2781. - void SetSelections(const PODVector<unsigned>& indices)
  2782. - void AddSelection(unsigned index)
  2783. - void RemoveSelection(unsigned index)
  2784. - void ToggleSelection(unsigned index)
  2785. - void ChangeSelection(int delta, bool additive = false)
  2786. - void ClearSelection()
  2787. - void SetHighlightMode(HighlightMode mode)
  2788. - void SetMultiselect(bool enable)
  2789. - void SetHierarchyMode(bool enable)
  2790. - void SetBaseIndent(int baseIndent)
  2791. - void SetClearSelectionOnDefocus(bool enable)
  2792. - void SetSelectOnClickEnd(bool enable)
  2793. - void Expand(unsigned index, bool enable, bool recursive = false)
  2794. - void ToggleExpand(unsigned index, bool recursive = false)
  2795. - unsigned GetNumItems() const
  2796. - UIElement* GetItem(unsigned index) const
  2797. - const PODVector<UIElement*>& GetItems() const
  2798. - unsigned FindItem(UIElement* item) const
  2799. - unsigned GetSelection() const
  2800. - const PODVector<unsigned>& GetSelections() const
  2801. - void CopySelectedItemsToClipboard() const
  2802. - UIElement* GetSelectedItem() const
  2803. - const PODVector<UIElement*>& GetSelectedItems() const
  2804. - bool IsSelected(unsigned index) const
  2805. - bool IsExpanded(unsigned index) const
  2806. - HighlightMode GetHighlightMode() const
  2807. - bool GetMultiselect() const
  2808. - bool GetClearSelectionOnDefocus() const
  2809. - bool GetSelectOnClickEnd() const
  2810. - bool GetHierarchyMode() const
  2811. - int GetBaseIndent() const
  2812. Properties:
  2813. - unsigned numItems (readonly)
  2814. - unsigned selection
  2815. - UIElement* selectedItem (readonly)
  2816. - HighlightMode highlightMode
  2817. - bool multiselect
  2818. - bool clearSelectionOnDefocus
  2819. - bool selectOnClickEnd
  2820. - bool hierarchyMode
  2821. - int baseIndent
  2822. <a name="Class_Localization"></a>
  2823. ### Localization : Object
  2824. Methods:
  2825. - int GetNumLanguages() const
  2826. - int GetLanguageIndex() const
  2827. - int GetLanguageIndex(const String language)
  2828. - String GetLanguage()
  2829. - String GetLanguage(int index)
  2830. - void SetLanguage(const String language)
  2831. - void SetLanguage(int index)
  2832. - String Get(const String id)
  2833. - void Reset()
  2834. - void LoadJSON(const JSONValue& source)
  2835. - void LoadJSONFile(const String name)
  2836. Properties:
  2837. - int numLanguages (readonly)
  2838. - int languageIndex (readonly)
  2839. - String language (readonly)
  2840. <a name="Class_Log"></a>
  2841. ### Log : Object
  2842. Methods:
  2843. - void Open(const String fileName)
  2844. - void Close()
  2845. - void SetLevel(int level)
  2846. - void SetTimeStamp(bool enable)
  2847. - void SetQuiet(bool quiet)
  2848. - int GetLevel() const
  2849. - bool GetTimeStamp() const
  2850. - String GetLastMessage() const
  2851. - bool IsQuiet() const
  2852. - void Write(int level, const String message)
  2853. - void WriteRaw(const String message, bool error = false)
  2854. Properties:
  2855. - int level
  2856. - bool timeStamp
  2857. - bool quiet
  2858. <a name="Class_LuaScriptInstance"></a>
  2859. ### LuaScriptInstance : Component
  2860. Methods:
  2861. - bool CreateObject(const String scriptObjectType)
  2862. - bool CreateObject(LuaFile* scriptFile, const String scriptObjectType)
  2863. - void SetScriptFile(LuaFile* scriptFile)
  2864. - void SetScriptObjectType(const String scriptObjectType)
  2865. - void SubscribeToEvent(const String eventName, void* functionOrFunctionName)
  2866. - void SubscribeToEvent(void* sender, const String eventName, void* functionOrFunctionName)
  2867. - void UnsubscribeFromEvent(const String eventName)
  2868. - void UnsubscribeFromEvent(Object* sender, const String eventName)
  2869. - void UnsubscribeFromEvents(Object* sender)
  2870. - void UnsubscribeFromAllEvents()
  2871. - void UnsubscribeFromAllEventsExcept(const Vector<String>& exceptionNames)
  2872. - bool HasSubscribedToEvent(const String eventName)
  2873. - bool HasSubscribedToEvent(Object* sender, const String eventName)
  2874. - LuaFile* GetScriptFile() const
  2875. - const String GetScriptObjectType() const
  2876. Properties:
  2877. - const LuaFile* scriptFile
  2878. - const String scriptObjectType
  2879. <a name="Class_Material"></a>
  2880. ### Material : Resource
  2881. Methods:
  2882. - Material() (GC)
  2883. - Material* new()
  2884. - void delete()
  2885. - void SetNumTechniques(unsigned num)
  2886. - void SetTechnique(unsigned index, Technique* tech, unsigned qualityLevel = 0, float lodDistance = 0.0f)
  2887. - void SetVertexShaderDefines(const String defines)
  2888. - void SetPixelShaderDefines(const String defines)
  2889. - void SetShaderParameter(const String name, const Variant& value)
  2890. - void SetShaderParameterAnimation(const String name, ValueAnimation* animation, WrapMode wrapMode = WM_LOOP, float speed = 1.0f)
  2891. - void SetShaderParameterAnimationWrapMode(const String name, WrapMode wrapMode)
  2892. - void SetShaderParameterAnimationSpeed(const String name, float speed)
  2893. - void SetTexture(TextureUnit unit, Texture* texture)
  2894. - void SetUVTransform(const Vector2& offset, float rotation, const Vector2& repeat)
  2895. - void SetUVTransform(const Vector2& offset, float rotation, float repeat)
  2896. - void SetCullMode(CullMode mode)
  2897. - void SetShadowCullMode(CullMode mode)
  2898. - void SetFillMode(FillMode mode)
  2899. - void SetDepthBias(const BiasParameters& parameters)
  2900. - void SetAlphaToCoverage(bool enable)
  2901. - void SetLineAntiAlias(bool enable)
  2902. - void SetRenderOrder(char renderOrder)
  2903. - void SetOcclusion(bool enable)
  2904. - void SetScene(Scene* scene)
  2905. - void RemoveShaderParameter(const String name)
  2906. - void ReleaseShaders()
  2907. - Material* Clone(const String cloneName = String::EMPTY) const
  2908. - void SortTechniques()
  2909. - void MarkForAuxView(unsigned frameNumber)
  2910. - unsigned GetNumTechniques() const
  2911. - Technique* GetTechnique(unsigned index) const
  2912. - Pass* GetPass(unsigned index, const String passName) const
  2913. - Texture* GetTexture(TextureUnit unit) const
  2914. - const String GetVertexShaderDefines() const
  2915. - const String GetPixelShaderDefines() const
  2916. - ValueAnimation* GetShaderParameterAnimation(const String name) const
  2917. - WrapMode GetShaderParameterAnimationWrapMode(const String name) const
  2918. - float GetShaderParameterAnimationSpeed(const String name) const
  2919. - CullMode GetCullMode() const
  2920. - CullMode GetShadowCullMode() const
  2921. - FillMode GetFillMode() const
  2922. - const BiasParameters& GetDepthBias() const
  2923. - bool GetAlphaToCoverage() const
  2924. - bool GetLineAntiAlias() const
  2925. - char GetRenderOrder() const
  2926. - bool GetOcclusion() const
  2927. - bool GetSpecular() const
  2928. - Scene* GetScene() const
  2929. Properties:
  2930. - String vertexShaderDefines
  2931. - String pixelShaderDefines
  2932. - CullMode cullMode
  2933. - CullMode shadowCullMode
  2934. - FillMode fillMode
  2935. - BiasParameters depthBias
  2936. - bool alphaToCoverage
  2937. - bool lineAntiAlias
  2938. - char renderOrder
  2939. - bool occlusion
  2940. - bool specular (readonly)
  2941. - Scene* scene
  2942. <a name="Class_Matrix3"></a>
  2943. ### Matrix3
  2944. Methods:
  2945. - Matrix3() (GC)
  2946. - Matrix3* new()
  2947. - Matrix3(const Matrix3& matrix) (GC)
  2948. - Matrix3* new(const Matrix3& matrix)
  2949. - Matrix3(float v00, float v01, float v02, float v10, float v11, float v12, float v20, float v21, float v22) (GC)
  2950. - Matrix3* new(float v00, float v01, float v02, float v10, float v11, float v12, float v20, float v21, float v22)
  2951. - void delete()
  2952. - bool operator==(const Matrix3& rhs) const
  2953. - Vector3 operator*(const Vector3& rhs) const
  2954. - Matrix3 operator+(const Matrix3& rhs) const
  2955. - Matrix3 operator-(const Matrix3& rhs) const
  2956. - Matrix3 operator*(float rhs) const
  2957. - Matrix3 operator*(const Matrix3& rhs) const
  2958. - void SetScale(const Vector3& scale)
  2959. - void SetScale(float scale)
  2960. - Vector3 Scale() const
  2961. - Matrix3 Transpose() const
  2962. - Matrix3 Scaled(const Vector3& scale) const
  2963. - bool Equals(const Matrix3& rhs) const
  2964. - Matrix3 Inverse() const
  2965. - String ToString() const
  2966. Properties:
  2967. - float m00
  2968. - float m01
  2969. - float m02
  2970. - float m10
  2971. - float m11
  2972. - float m12
  2973. - float m20
  2974. - float m21
  2975. - float m22
  2976. - const Matrix3 ZERO
  2977. - const Matrix3 IDENTITY
  2978. <a name="Class_Matrix3x4"></a>
  2979. ### Matrix3x4
  2980. Methods:
  2981. - Matrix3x4() (GC)
  2982. - Matrix3x4* new()
  2983. - Matrix3x4(const Matrix3x4& matrix) (GC)
  2984. - Matrix3x4* new(const Matrix3x4& matrix)
  2985. - Matrix3x4(const Matrix3& matrix) (GC)
  2986. - Matrix3x4* new(const Matrix3& matrix)
  2987. - Matrix3x4(const Matrix4& matrix) (GC)
  2988. - Matrix3x4* new(const Matrix4& matrix)
  2989. - 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)
  2990. - 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)
  2991. - Matrix3x4(const Vector3& translation, const Quaternion& rotation, float scale) (GC)
  2992. - Matrix3x4* new(const Vector3& translation, const Quaternion& rotation, float scale)
  2993. - Matrix3x4(const Vector3& translation, const Quaternion& rotation, const Vector3& scale) (GC)
  2994. - Matrix3x4* new(const Vector3& translation, const Quaternion& rotation, const Vector3& scale)
  2995. - void delete()
  2996. - bool operator==(const Matrix3x4& rhs) const
  2997. - Vector3 operator*(const Vector3& rhs) const
  2998. - Vector3 operator*(const Vector4& rhs) const
  2999. - Matrix3x4 operator+(const Matrix3x4& rhs) const
  3000. - Matrix3x4 operator-(const Matrix3x4& rhs) const
  3001. - Matrix3x4 operator*(float rhs) const
  3002. - Matrix3x4 operator*(const Matrix3x4& rhs) const
  3003. - Matrix4 operator*(const Matrix4& rhs) const
  3004. - void SetTranslation(const Vector3& translation)
  3005. - void SetRotation(const Matrix3& rotation)
  3006. - void SetScale(const Vector3& scale)
  3007. - void SetScale(float scale)
  3008. - Matrix3 ToMatrix3() const
  3009. - Matrix4 ToMatrix4() const
  3010. - Matrix3 RotationMatrix() const
  3011. - Vector3 Translation() const
  3012. - Quaternion Rotation() const
  3013. - Vector3 Scale() const
  3014. - bool Equals(const Matrix3x4& rhs) const
  3015. - void Decompose(Vector3& translation, Quaternion& rotation, Vector3& scale) const
  3016. - Matrix3x4 Inverse() const
  3017. - String ToString() const
  3018. Properties:
  3019. - float m00
  3020. - float m01
  3021. - float m02
  3022. - float m03
  3023. - float m10
  3024. - float m11
  3025. - float m12
  3026. - float m13
  3027. - float m20
  3028. - float m21
  3029. - float m22
  3030. - float m23
  3031. - const Matrix3x4 ZERO
  3032. - const Matrix3x4 IDENTITY
  3033. <a name="Class_Matrix4"></a>
  3034. ### Matrix4
  3035. Methods:
  3036. - Matrix4() (GC)
  3037. - Matrix4* new()
  3038. - Matrix4(const Matrix4& matrix) (GC)
  3039. - Matrix4* new(const Matrix4& matrix)
  3040. - Matrix4(const Matrix3& matrix) (GC)
  3041. - Matrix4* new(const Matrix3& matrix)
  3042. - 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)
  3043. - 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)
  3044. - void delete()
  3045. - bool operator==(const Matrix4& rhs) const
  3046. - Vector3 operator*(const Vector3& rhs) const
  3047. - Vector4 operator*(const Vector4& rhs) const
  3048. - Matrix4 operator+(const Matrix4& rhs) const
  3049. - Matrix4 operator-(const Matrix4& rhs) const
  3050. - Matrix4 operator*(float rhs) const
  3051. - Matrix4 operator*(const Matrix4& rhs) const
  3052. - Matrix4 operator*(const Matrix3x4& rhs) const
  3053. - void SetTranslation(const Vector3& translation)
  3054. - void SetRotation(const Matrix3& rotation)
  3055. - void SetScale(const Vector3& scale)
  3056. - void SetScale(float scale)
  3057. - Matrix3 ToMatrix3() const
  3058. - Matrix3 RotationMatrix() const
  3059. - Vector3 Translation() const
  3060. - Quaternion Rotation() const
  3061. - Vector3 Scale() const
  3062. - Matrix4 Transpose() const
  3063. - bool Equals(const Matrix4& rhs) const
  3064. - void Decompose(Vector3& translation, Quaternion& rotation, Vector3& scale) const
  3065. - Matrix4 Inverse() const
  3066. - String ToString() const
  3067. Properties:
  3068. - float m00
  3069. - float m01
  3070. - float m02
  3071. - float m03
  3072. - float m10
  3073. - float m11
  3074. - float m12
  3075. - float m13
  3076. - float m20
  3077. - float m21
  3078. - float m22
  3079. - float m23
  3080. - float m30
  3081. - float m31
  3082. - float m32
  3083. - float m33
  3084. - const Matrix4 ZERO
  3085. - const Matrix4 IDENTITY
  3086. <a name="Class_Menu"></a>
  3087. ### Menu : Button
  3088. Methods:
  3089. - Menu() (GC)
  3090. - Menu* new()
  3091. - void delete()
  3092. - void SetPopup(UIElement* element)
  3093. - void SetPopupOffset(const IntVector2& offset)
  3094. - void SetPopupOffset(int x, int y)
  3095. - void ShowPopup(bool enable)
  3096. - void SetAccelerator(int key, int qualifiers)
  3097. - UIElement* GetPopup() const
  3098. - const IntVector2& GetPopupOffset() const
  3099. - bool GetShowPopup() const
  3100. - int GetAcceleratorKey() const
  3101. - int GetAcceleratorQualifiers() const
  3102. Properties:
  3103. - UIElement* popup
  3104. - IntVector2& popupOffset
  3105. - bool showPopup
  3106. - int acceleratorKey (readonly)
  3107. - int acceleratorQualifiers (readonly)
  3108. <a name="Class_MessageBox"></a>
  3109. ### MessageBox : Object
  3110. Methods:
  3111. - MessageBox(const String messageString = String::EMPTY, const String titleString = String::EMPTY, XMLFile* layoutFile = 0, XMLFile* styleFile = 0) (GC)
  3112. - MessageBox* new(const String messageString = String::EMPTY, const String titleString = String::EMPTY, XMLFile* layoutFile = 0, XMLFile* styleFile = 0)
  3113. - void delete()
  3114. - void SetTitle(const String text)
  3115. - void SetMessage(const String text)
  3116. - const String GetTitle() const
  3117. - const String GetMessage() const
  3118. - UIElement* GetWindow() const
  3119. Properties:
  3120. - String title
  3121. - String message
  3122. - UIElement* window (readonly)
  3123. <a name="Class_Model"></a>
  3124. ### Model : Resource
  3125. Methods:
  3126. - Model() (GC)
  3127. - Model* new()
  3128. - void delete()
  3129. - Model* Clone(const String cloneName = String::EMPTY) const
  3130. - void SetBoundingBox(const BoundingBox& box)
  3131. - bool SetVertexBuffers(const Vector<SharedPtr<VertexBuffer> >& buffers, const PODVector<unsigned>& morphRangeStarts, const PODVector<unsigned>& morphRangeCounts)
  3132. - bool SetIndexBuffers(const Vector<SharedPtr<IndexBuffer> >& buffers)
  3133. - void SetNumGeometries(unsigned num)
  3134. - bool SetNumGeometryLodLevels(unsigned index, unsigned num)
  3135. - bool SetGeometry(unsigned index, unsigned lodLevel, Geometry* geometry)
  3136. - bool SetGeometryCenter(unsigned index, const Vector3& center)
  3137. - const BoundingBox& GetBoundingBox() const
  3138. - Skeleton& GetSkeleton()
  3139. - unsigned GetNumGeometries() const
  3140. - unsigned GetNumGeometryLodLevels(unsigned index) const
  3141. - Geometry* GetGeometry(unsigned index, unsigned lodLevel) const
  3142. - const Vector3& GetGeometryCenter(unsigned index) const
  3143. - unsigned GetNumMorphs() const
  3144. - const ModelMorph* GetMorph(const String name) const
  3145. - const ModelMorph* GetMorph(StringHash nameHash) const
  3146. - const ModelMorph* GetMorph(unsigned index) const
  3147. - unsigned GetMorphRangeStart(unsigned bufferIndex) const
  3148. - unsigned GetMorphRangeCount(unsigned bufferIndex) const
  3149. Properties:
  3150. - BoundingBox& boundingBox
  3151. - Skeleton skeleton (readonly)
  3152. - unsigned numGeometries
  3153. - unsigned numMorphs (readonly)
  3154. <a name="Class_NamedPipe"></a>
  3155. ### NamedPipe : Object
  3156. Methods:
  3157. - NamedPipe() (GC)
  3158. - NamedPipe* new()
  3159. - NamedPipe(const String pipeName, bool isServer) (GC)
  3160. - NamedPipe* new(const String pipeName, bool isServer)
  3161. - void delete()
  3162. - bool Open(const String pipeName, bool isServer)
  3163. - void Close()
  3164. - bool IsOpen() const
  3165. - VectorBuffer Read(unsigned size)
  3166. - const String GetName() const
  3167. - bool IsEof() const
  3168. - int ReadInt()
  3169. - short ReadShort()
  3170. - char ReadByte()
  3171. - unsigned ReadUInt()
  3172. - short ReadUShort()
  3173. - char ReadUByte()
  3174. - bool ReadBool()
  3175. - float ReadFloat()
  3176. - double ReadDouble()
  3177. - IntRect ReadIntRect()
  3178. - IntVector2 ReadIntVector2()
  3179. - IntVector3 ReadIntVector3()
  3180. - Rect ReadRect()
  3181. - Vector2 ReadVector2()
  3182. - Vector3 ReadVector3()
  3183. - Vector3 ReadPackedVector3(float maxAbsCoord)
  3184. - Vector4 ReadVector4()
  3185. - Quaternion ReadQuaternion()
  3186. - Quaternion ReadPackedQuaternion()
  3187. - Matrix3 ReadMatrix3()
  3188. - Matrix3x4 ReadMatrix3x4()
  3189. - Matrix4 ReadMatrix4()
  3190. - Color ReadColor()
  3191. - BoundingBox ReadBoundingBox()
  3192. - String ReadString()
  3193. - String ReadFileID()
  3194. - StringHash ReadStringHash()
  3195. - VectorBuffer ReadBuffer()
  3196. - ResourceRef ReadResourceRef()
  3197. - ResourceRefList ReadResourceRefList()
  3198. - Variant ReadVariant()
  3199. - Variant ReadVariant(VariantType type)
  3200. - VariantVector ReadVariantVector()
  3201. - VariantMap ReadVariantMap()
  3202. - unsigned ReadVLE()
  3203. - unsigned ReadNetID()
  3204. - String ReadLine()
  3205. - unsigned Write(const VectorBuffer& buffer)
  3206. - bool WriteInt(int value)
  3207. - bool WriteShort(short value)
  3208. - bool WriteByte(char value)
  3209. - bool WriteUInt(unsigned value)
  3210. - bool WriteUShort(short value)
  3211. - bool WriteUByte(char value)
  3212. - bool WriteBool(bool value)
  3213. - bool WriteFloat(float value)
  3214. - bool WriteDouble(double value)
  3215. - bool WriteIntRect(const IntRect& value)
  3216. - bool WriteIntVector2(const IntVector2& value)
  3217. - bool WriteIntVector3(const IntVector3& value)
  3218. - bool WriteRect(const Rect& value)
  3219. - bool WriteVector2(const Vector2& value)
  3220. - bool WriteVector3(const Vector3& value)
  3221. - bool WritePackedVector3(const Vector3& value, float maxAbsCoord)
  3222. - bool WriteVector4(const Vector4& value)
  3223. - bool WriteQuaternion(const Quaternion& value)
  3224. - bool WritePackedQuaternion(const Quaternion& value)
  3225. - bool WriteMatrix3(const Matrix3& value)
  3226. - bool WriteMatrix3x4(const Matrix3x4& value)
  3227. - bool WriteMatrix4(const Matrix4& value)
  3228. - bool WriteColor(const Color& value)
  3229. - bool WriteBoundingBox(const BoundingBox& value)
  3230. - bool WriteString(const String value)
  3231. - bool WriteFileID(const String value)
  3232. - bool WriteStringHash(const StringHash& value)
  3233. - bool WriteBuffer(const VectorBuffer& buffer)
  3234. - bool WriteResourceRef(const ResourceRef& value)
  3235. - bool WriteResourceRefList(const ResourceRefList& value)
  3236. - bool WriteVariant(const Variant& value)
  3237. - bool WriteVariantData(const Variant& value)
  3238. - bool WriteVariantVector(const VariantVector& value)
  3239. - bool WriteVariantMap(const VariantMap& value)
  3240. - bool WriteVLE(unsigned value)
  3241. - bool WriteNetID(unsigned value)
  3242. - bool WriteLine(const String value)
  3243. Properties:
  3244. - String name (readonly)
  3245. - bool eof (readonly)
  3246. - bool open (readonly)
  3247. <a name="Class_NavArea"></a>
  3248. ### NavArea : Component
  3249. Methods:
  3250. - unsigned GetAreaID() const
  3251. - void SetAreaID(unsigned tolua_var_3)
  3252. - BoundingBox GetBoundingBox()
  3253. - void SetBoundingBox(const BoundingBox& bnds)
  3254. - BoundingBox GetWorldBoundingBox() const
  3255. Properties:
  3256. - unsigned areaID
  3257. - BoundingBox boundingBox
  3258. - BoundingBox worldBoundingBox (readonly)
  3259. <a name="Class_Navigable"></a>
  3260. ### Navigable : Component
  3261. Methods:
  3262. - void SetRecursive(bool enable)
  3263. - bool IsRecursive() const
  3264. Properties:
  3265. - bool recursive
  3266. <a name="Class_NavigationGeometryInfo"></a>
  3267. ### NavigationGeometryInfo
  3268. Properties:
  3269. - Component* component
  3270. - unsigned lodLevel
  3271. - Matrix3x4 transform
  3272. - BoundingBox boundingBox
  3273. <a name="Class_NavigationMesh"></a>
  3274. ### NavigationMesh : Component
  3275. Methods:
  3276. - void SetTileSize(int size)
  3277. - void SetCellSize(float size)
  3278. - void SetCellHeight(float height)
  3279. - void SetAgentHeight(float height)
  3280. - void SetAgentRadius(float radius)
  3281. - void SetAgentMaxClimb(float maxClimb)
  3282. - void SetAgentMaxSlope(float maxSlope)
  3283. - void SetRegionMinSize(float size)
  3284. - void SetRegionMergeSize(float size)
  3285. - void SetEdgeMaxLength(float length)
  3286. - void SetEdgeMaxError(float error)
  3287. - void SetDetailSampleDistance(float distance)
  3288. - void SetDetailSampleMaxError(float error)
  3289. - void SetPadding(const Vector3& padding)
  3290. - void SetAreaCost(unsigned areaID, float cost)
  3291. - bool Build()
  3292. - bool Build(const BoundingBox& boundingBox)
  3293. - void SetPartitionType(NavmeshPartitionType aType)
  3294. - void SetDrawOffMeshConnections(bool enable)
  3295. - void SetDrawNavAreas(bool enable)
  3296. - Vector3 FindNearestPoint(const Vector3& point)
  3297. - Vector3 FindNearestPoint(const Vector3& point, const Vector3& extents)
  3298. - Vector3 MoveAlongSurface(const Vector3& start, const Vector3& end)
  3299. - Vector3 MoveAlongSurface(const Vector3& start, const Vector3& end, const Vector3& extents, int maxVisited = 3)
  3300. - const PODVector<Vector3>& FindPath(const Vector3& start, const Vector3& end)
  3301. - const PODVector<Vector3>& FindPath(const Vector3& start, const Vector3& end, const Vector3& extents)
  3302. - Vector3 GetRandomPoint()
  3303. - Vector3 GetRandomPointInCircle(const Vector3& center, float radius)
  3304. - Vector3 GetRandomPointInCircle(const Vector3& center, float radius, const Vector3& extents)
  3305. - float GetDistanceToWall(const Vector3& point, float radius)
  3306. - float GetDistanceToWall(const Vector3& point, float radius, const Vector3& extents)
  3307. - Vector3 Raycast(const Vector3& start, const Vector3& end)
  3308. - Vector3 Raycast(const Vector3& start, const Vector3& end, const Vector3& extents)
  3309. - void DrawDebugGeometry(bool depthTest)
  3310. - int GetTileSize() const
  3311. - float GetCellSize() const
  3312. - float GetCellHeight() const
  3313. - float GetAgentHeight() const
  3314. - float GetAgentRadius() const
  3315. - float GetAgentMaxClimb() const
  3316. - float GetAgentMaxSlope() const
  3317. - float GetRegionMinSize() const
  3318. - float GetRegionMergeSize() const
  3319. - float GetEdgeMaxLength() const
  3320. - float GetEdgeMaxError() const
  3321. - float GetDetailSampleDistance() const
  3322. - float GetDetailSampleMaxError() const
  3323. - const Vector3& GetPadding() const
  3324. - float GetAreaCost(unsigned areaID) const
  3325. - bool IsInitialized() const
  3326. - const BoundingBox& GetBoundingBox() const
  3327. - BoundingBox GetWorldBoundingBox() const
  3328. - IntVector2 GetNumTiles() const
  3329. - NavmeshPartitionType GetPartitionType()
  3330. - bool GetDrawOffMeshConnections() const
  3331. - bool GetDrawNavAreas() const
  3332. Properties:
  3333. - int tileSize
  3334. - float cellSize
  3335. - float cellHeight
  3336. - float agentHeight
  3337. - float agentRadius
  3338. - float agentMaxClimb
  3339. - float agentMaxSlope
  3340. - float regionMinSize
  3341. - float regionMergeSize
  3342. - float edgeMaxLength
  3343. - float edgeMaxError
  3344. - float detailSampleDistance
  3345. - float detailSampleMaxError
  3346. - Vector3& padding
  3347. - NavmeshPartitionType partitionType
  3348. - bool drawOffMeshConnections
  3349. - bool drawNavAreas
  3350. - bool initialized (readonly)
  3351. - BoundingBox& boundingBox (readonly)
  3352. - BoundingBox worldBoundingBox (readonly)
  3353. - IntVector2 numTiles (readonly)
  3354. <a name="Class_Network"></a>
  3355. ### Network
  3356. Methods:
  3357. - bool Connect(const String address, short port, Scene* scene)
  3358. - bool Connect(const String address, short port, Scene* scene, const VariantMap& identity)
  3359. - void Disconnect(int waitMSec = 0)
  3360. - bool StartServer(short port)
  3361. - void StopServer()
  3362. - void BroadcastMessage(int msgID, bool reliable, bool inOrder, const VectorBuffer& msg, unsigned contentID = 0)
  3363. - void BroadcastRemoteEvent(StringHash eventType, bool inOrder)
  3364. - void BroadcastRemoteEvent(StringHash eventType, bool inOrder, const VariantMap& eventData)
  3365. - void BroadcastRemoteEvent(const String eventType, bool inOrder)
  3366. - void BroadcastRemoteEvent(const String eventType, bool inOrder, const VariantMap& eventData)
  3367. - void BroadcastRemoteEvent(Scene* scene, StringHash eventType, bool inOrder)
  3368. - void BroadcastRemoteEvent(Scene* scene, StringHash eventType, bool inOrder, const VariantMap& eventData)
  3369. - void BroadcastRemoteEvent(Scene* scene, const String eventType, bool inOrder)
  3370. - void BroadcastRemoteEvent(Scene* scene, const String eventType, bool inOrder, const VariantMap& eventData)
  3371. - void BroadcastRemoteEvent(Node* node, StringHash eventType, bool inOrder)
  3372. - void BroadcastRemoteEvent(Node* node, StringHash eventType, bool inOrder, const VariantMap& eventData)
  3373. - void BroadcastRemoteEvent(Node* node, const String eventType, bool inOrder)
  3374. - void BroadcastRemoteEvent(Node* node, const String eventType, bool inOrder, const VariantMap& eventData)
  3375. - void SetUpdateFps(int fps)
  3376. - void SetSimulatedLatency(int ms)
  3377. - void SetSimulatedPacketLoss(float loss)
  3378. - void RegisterRemoteEvent(StringHash eventType)
  3379. - void RegisterRemoteEvent(const String eventType)
  3380. - void UnregisterRemoteEvent(StringHash eventType)
  3381. - void UnregisterRemoteEvent(const String eventType)
  3382. - void UnregisterAllRemoteEvents()
  3383. - void SetPackageCacheDir(const String path)
  3384. - void SendPackageToClients(Scene* scene, PackageFile* package)
  3385. - HttpRequest* MakeHttpRequest(const String url, const String verb = String::EMPTY)
  3386. - HttpRequest* MakeHttpRequest(const String url, const String verb, const Vector<String>& headers, const String postData = String::EMPTY)
  3387. - int GetUpdateFps() const
  3388. - int GetSimulatedLatency() const
  3389. - float GetSimulatedPacketLoss() const
  3390. - Connection* GetServerConnection() const
  3391. - bool IsServerRunning() const
  3392. - bool CheckRemoteEvent(StringHash eventType) const
  3393. - const String GetPackageCacheDir() const
  3394. Properties:
  3395. - int updateFps
  3396. - int simulatedLatency
  3397. - float simulatedPacketLoss
  3398. - Connection* serverConnection (readonly)
  3399. - bool serverRunning (readonly)
  3400. - String packageCacheDir
  3401. <a name="Class_NetworkPriority"></a>
  3402. ### NetworkPriority : Component
  3403. Methods:
  3404. - void SetBasePriority(float priority)
  3405. - void SetDistanceFactor(float factor)
  3406. - void SetMinPriority(float priority)
  3407. - void SetAlwaysUpdateOwner(bool enable)
  3408. - float GetBasePriority() const
  3409. - float GetDistanceFactor() const
  3410. - float GetMinPriority() const
  3411. - bool GetAlwaysUpdateOwner() const
  3412. - bool CheckUpdate(float distance, float accumulator)
  3413. Properties:
  3414. - float basePriority
  3415. - float distanceFactor
  3416. - float minPriority
  3417. - bool alwaysUpdateOwner
  3418. <a name="Class_Node"></a>
  3419. ### Node : Animatable
  3420. Methods:
  3421. - Node() (GC)
  3422. - Node* new()
  3423. - void delete()
  3424. - bool SaveXML(File* dest, const String indentation = "\t") const
  3425. - bool SaveJSON(File* dest, const String indentation = "\t") const
  3426. - void SetName(const String name)
  3427. - void AddTag(const String tag)
  3428. - void AddTags(const String tags, char separator)
  3429. - bool RemoveTag(const String tag)
  3430. - void RemoveAllTags()
  3431. - void SetPosition(const Vector3& position)
  3432. - void SetPosition2D(const Vector2& position)
  3433. - void SetPosition2D(float x, float y)
  3434. - void SetRotation(const Quaternion& rotation)
  3435. - void SetRotation2D(float rotation)
  3436. - void SetDirection(const Vector3& direction)
  3437. - void SetScale(float scale)
  3438. - void SetScale(const Vector3& scale)
  3439. - void SetScale2D(const Vector2& scale)
  3440. - void SetScale2D(float x, float y)
  3441. - void SetTransform(const Vector3& position, const Quaternion& rotation)
  3442. - void SetTransform(const Vector3& position, const Quaternion& rotation, const Vector3& scale)
  3443. - void SetTransform(const Vector3& position, const Quaternion& rotation, float scale)
  3444. - void SetTransform(const Matrix3x4& transform)
  3445. - void SetTransform2D(const Vector2& position, float rotation)
  3446. - void SetTransform2D(const Vector2& position, float rotation, const Vector2& scale)
  3447. - void SetTransform2D(const Vector2& position, float rotation, float scale)
  3448. - void SetWorldPosition(const Vector3& position)
  3449. - void SetWorldPosition2D(const Vector2& position)
  3450. - void SetWorldPosition2D(float x, float y)
  3451. - void SetWorldRotation(const Quaternion& rotation)
  3452. - void SetWorldRotation2D(float rotation)
  3453. - void SetWorldDirection(const Vector3& direction)
  3454. - void SetWorldScale(float scale)
  3455. - void SetWorldScale(const Vector3& scale)
  3456. - void SetWorldScale2D(const Vector2& scale)
  3457. - void SetWorldScale2D(float x, float y)
  3458. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation)
  3459. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation, const Vector3& scale)
  3460. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation, float scale)
  3461. - void SetWorldTransform2D(const Vector2& position, float rotation)
  3462. - void SetWorldTransform2D(const Vector2& position, float rotation, const Vector2& scale)
  3463. - void SetWorldTransform2D(const Vector2& position, float rotation, float scale)
  3464. - void Translate(const Vector3& delta, TransformSpace space = TS_LOCAL)
  3465. - void Translate2D(const Vector2& delta, TransformSpace space = TS_LOCAL)
  3466. - void Rotate(const Quaternion& delta, TransformSpace space = TS_LOCAL)
  3467. - void Rotate2D(float delta, TransformSpace space = TS_LOCAL)
  3468. - void RotateAround(const Vector3& point, const Quaternion& delta, TransformSpace space = TS_LOCAL)
  3469. - void RotateAround2D(const Vector2& point, float delta, TransformSpace space = TS_LOCAL)
  3470. - void Pitch(float angle, TransformSpace space = TS_LOCAL)
  3471. - void Yaw(float angle, TransformSpace space = TS_LOCAL)
  3472. - void Roll(float angle, TransformSpace space = TS_LOCAL)
  3473. - bool LookAt(const Vector3& target)
  3474. - bool LookAt(const Vector3& target, const Vector3& upAxis, TransformSpace space = TS_WORLD)
  3475. - void Scale(float scale)
  3476. - void Scale(const Vector3& scale)
  3477. - void Scale2D(const Vector2& scale)
  3478. - void SetEnabled(bool enable)
  3479. - void SetDeepEnabled(bool enable)
  3480. - void ResetDeepEnabled()
  3481. - void SetEnabledRecursive(bool enable)
  3482. - void SetOwner(Connection* owner)
  3483. - void MarkDirty()
  3484. - Node* CreateChild(const String name = String::EMPTY, CreateMode mode = REPLICATED, unsigned id = 0, bool temporary = false)
  3485. - Node* CreateTemporaryChild(const String name = String::EMPTY, CreateMode mode = REPLICATED, unsigned id = 0)
  3486. - void AddChild(Node* node, unsigned index = M_MAX_UNSIGNED)
  3487. - void RemoveChild(Node* node)
  3488. - void RemoveAllChildren()
  3489. - void RemoveChildren(bool removeReplicated, bool removeLocal, bool recursive)
  3490. - void RemoveComponent(Component* component)
  3491. - void RemoveComponent(StringHash type)
  3492. - void RemoveComponent(const String type)
  3493. - void RemoveComponents(bool removeReplicated, bool removeLocal)
  3494. - void RemoveComponents(const String type)
  3495. - void RemoveAllComponents()
  3496. - void ReorderComponent(Component* component, unsigned index)
  3497. - Node* Clone(CreateMode mode = REPLICATED)
  3498. - void Remove()
  3499. - void SetParent(Node* parent)
  3500. - void SetVar(StringHash key, const Variant& value)
  3501. - void AddListener(Component* component)
  3502. - void RemoveListener(Component* component)
  3503. - Component* CreateComponent(const String type, CreateMode mode = REPLICATED, unsigned id = 0)
  3504. - Component* GetOrCreateComponent(const String type, CreateMode mode = REPLICATED, unsigned id = 0)
  3505. - Component* CloneComponent(Component* component, unsigned id = 0)
  3506. - Component* CloneComponent(Component* component, CreateMode mode, unsigned id = 0)
  3507. - int CreateScriptObject(const String scriptObjectType)
  3508. - int CreateScriptObject(const String fileName, const String scriptObjectType)
  3509. - int GetScriptObject() const
  3510. - int GetScriptObject(const String scriptObjectType) const
  3511. - unsigned GetID() const
  3512. - const String GetName() const
  3513. - StringHash GetNameHash() const
  3514. - Node* GetParent() const
  3515. - Scene* GetScene() const
  3516. - bool IsEnabled() const
  3517. - bool IsEnabledSelf() const
  3518. - Connection* GetOwner() const
  3519. - const Vector3& GetPosition() const
  3520. - Vector2 GetPosition2D() const
  3521. - const Quaternion& GetRotation() const
  3522. - float GetRotation2D() const
  3523. - Vector3 GetDirection() const
  3524. - Vector3 GetUp() const
  3525. - Vector3 GetRight() const
  3526. - const Vector3& GetScale() const
  3527. - Vector2 GetScale2D() const
  3528. - Matrix3x4 GetTransform() const
  3529. - Vector3 GetWorldPosition() const
  3530. - Vector2 GetWorldPosition2D() const
  3531. - Quaternion GetWorldRotation() const
  3532. - float GetWorldRotation2D() const
  3533. - Vector3 GetWorldDirection() const
  3534. - Vector3 GetWorldUp() const
  3535. - Vector3 GetWorldRight() const
  3536. - Vector3 GetWorldScale() const
  3537. - Vector2 GetWorldScale2D() const
  3538. - const Matrix3x4& GetWorldTransform() const
  3539. - Vector3 LocalToWorld(const Vector3& position) const
  3540. - Vector3 LocalToWorld(const Vector4& vector) const
  3541. - Vector2 LocalToWorld2D(const Vector2& vector) const
  3542. - Vector3 WorldToLocal(const Vector3& position) const
  3543. - Vector3 WorldToLocal(const Vector4& vector) const
  3544. - Vector2 WorldToLocal2D(const Vector2& vector) const
  3545. - bool IsDirty() const
  3546. - unsigned GetNumChildren(bool recursive = false) const
  3547. - Node* GetChild(const String name, bool recursive = false) const
  3548. - Node* GetChild(StringHash nameHash, bool recursive = false) const
  3549. - Node* GetChild(unsigned index) const
  3550. - unsigned GetNumComponents() const
  3551. - unsigned GetNumNetworkComponents() const
  3552. - bool HasComponent(StringHash type) const
  3553. - bool HasComponent(const String type) const
  3554. - const Variant& GetVar(StringHash key) const
  3555. - const VariantMap& GetVars() const
  3556. - Component* GetComponent(const String type, bool recursive = false) const
  3557. - Component* GetParentComponent(const String type, bool recursive = false) const
  3558. - const PODVector<Component*>& GetComponents(const String type, bool recursive = false)
  3559. - const PODVector<Node*>& GetChildren(bool recursive = false)
  3560. - const PODVector<Node*>& GetChildrenWithComponent(const String type, bool recursive = false)
  3561. - bool Load(Deserializer& source, SceneResolver& resolver, bool loadChildren = true, bool rewriteIDs = false, CreateMode mode = REPLICATED)
  3562. - bool LoadXML(const XMLElement& source, SceneResolver& resolver, bool loadChildren = true, bool rewriteIDs = false, CreateMode mode = REPLICATED)
  3563. - bool LoadJSON(const JSONValue& source, SceneResolver& resolver, bool loadChildren = true, bool rewriteIDs = false, CreateMode mode = REPLICATED)
  3564. - Node* CreateChild(unsigned id, CreateMode mode, bool temporary = false)
  3565. - void AddComponent(Component* component, unsigned id, CreateMode mode)
  3566. - bool HasTag(const String tag) const
  3567. - const StringVector& GetTags() const
  3568. - const PODVector<Node*>& GetChildrenWithTag(const String tag, bool recursive = false) const
  3569. - void SetID(unsigned id)
  3570. Properties:
  3571. - unsigned ID (readonly)
  3572. - String name
  3573. - StringHash nameHash (readonly)
  3574. - Node* parent
  3575. - Scene* scene (readonly)
  3576. - bool enabled
  3577. - bool enabledSelf (readonly)
  3578. - Connection* owner
  3579. - Vector3& position
  3580. - Vector2 position2D
  3581. - Quaternion& rotation
  3582. - float rotation2D
  3583. - Vector3 direction
  3584. - Vector3 up (readonly)
  3585. - Vector3 right (readonly)
  3586. - Vector3& scale
  3587. - Vector2 scale2D
  3588. - Matrix3x4 transform (readonly)
  3589. - Vector3 worldPosition
  3590. - Vector2 worldPosition2D
  3591. - Quaternion worldRotation
  3592. - float worldRotation2D
  3593. - Vector3 worldDirection
  3594. - Vector3 worldUp (readonly)
  3595. - Vector3 worldRight (readonly)
  3596. - Vector3 worldScale
  3597. - Vector2 worldScale2D
  3598. - Matrix3x4& worldTransform (readonly)
  3599. - bool dirty (readonly)
  3600. - unsigned numComponents (readonly)
  3601. - unsigned numNetworkComponents (readonly)
  3602. <a name="Class_Object"></a>
  3603. ### Object : RefCounted
  3604. Methods:
  3605. - StringHash GetType() const
  3606. - const String GetTypeName() const
  3607. - const String GetCategory() const
  3608. - void SendEvent(const String eventName, VariantMap* eventData = 0)
  3609. - bool HasSubscribedToEvent(const String eventName) const
  3610. - bool HasSubscribedToEvent(Object* sender, const String eventName) const
  3611. Properties:
  3612. - StringHash type (readonly)
  3613. - const String typeName (readonly)
  3614. - const String category (readonly)
  3615. <a name="Class_ObjectAnimation"></a>
  3616. ### ObjectAnimation : Resource
  3617. Methods:
  3618. - ObjectAnimation() (GC)
  3619. - ObjectAnimation* new()
  3620. - void delete()
  3621. - void AddAttributeAnimation(const String name, ValueAnimation* attributeAnimation, WrapMode wrapMode = WM_LOOP, float speed = 1.0f)
  3622. - void RemoveAttributeAnimation(const String name)
  3623. - void RemoveAttributeAnimation(ValueAnimation* attributeAnimation)
  3624. - ValueAnimation* GetAttributeAnimation(const String name) const
  3625. - WrapMode GetAttributeAnimationWrapMode(const String name) const
  3626. - float GetAttributeAnimationSpeed(const String name) const
  3627. <a name="Class_Obstacle"></a>
  3628. ### Obstacle : Component
  3629. Methods:
  3630. - void DrawDebugGeometry(bool depthTest)
  3631. - void SetRadius(float radius)
  3632. - void SetHeight(float height)
  3633. - float GetRadius() const
  3634. - float GetHeight() const
  3635. Properties:
  3636. - float radius
  3637. - float height
  3638. <a name="Class_Octree"></a>
  3639. ### Octree : Component
  3640. Methods:
  3641. - void SetSize(const BoundingBox& box, unsigned numLevels)
  3642. - void Update(const FrameInfo& frame)
  3643. - void AddManualDrawable(Drawable* drawable)
  3644. - void RemoveManualDrawable(Drawable* drawable)
  3645. - const PODVector<OctreeQueryResult>& GetDrawables(const Vector3& point, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3646. - const PODVector<OctreeQueryResult>& GetDrawables(const BoundingBox& box, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3647. - const PODVector<OctreeQueryResult>& GetDrawables(const Frustum& frustum, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3648. - const PODVector<OctreeQueryResult>& GetDrawables(const Sphere& sphere, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3649. - const PODVector<OctreeQueryResult>& GetAllDrawables(char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3650. - const PODVector<RayQueryResult>& Raycast(const Ray& ray, RayQueryLevel level, float maxDistance, char drawableFlags, unsigned viewMask = DEFAULT_VIEWMASK) const
  3651. - RayQueryResult RaycastSingle(const Ray& ray, RayQueryLevel level, float maxDistance, char drawableFlags, unsigned viewMask = DEFAULT_VIEWMASK) const
  3652. - unsigned GetNumLevels() const
  3653. - void QueueUpdate(Drawable* drawable)
  3654. - void DrawDebugGeometry(bool depthTest)
  3655. Properties:
  3656. - unsigned numLevels (readonly)
  3657. <a name="Class_OctreeQueryResult"></a>
  3658. ### OctreeQueryResult
  3659. Methods:
  3660. - OctreeQueryResult() (GC)
  3661. - OctreeQueryResult* new()
  3662. - void delete()
  3663. Properties:
  3664. - Drawable* drawable
  3665. - Node* node
  3666. <a name="Class_OffMeshConnection"></a>
  3667. ### OffMeshConnection : Component
  3668. Methods:
  3669. - void SetEndPoint(Node* node)
  3670. - void SetRadius(float radius)
  3671. - void SetBidirectional(bool enabled)
  3672. - void SetMask(unsigned newMask)
  3673. - void SetAreaID(unsigned newAreaID)
  3674. - Node* GetEndPoint() const
  3675. - float GetRadius() const
  3676. - bool IsBidirectional() const
  3677. - unsigned GetMask() const
  3678. - unsigned GetAreaID() const
  3679. Properties:
  3680. - Node* endPoint
  3681. - float radius
  3682. - bool bidirectional
  3683. - unsigned mask
  3684. - unsigned areaID
  3685. <a name="Class_PackageEntry"></a>
  3686. ### PackageEntry
  3687. Properties:
  3688. - unsigned offset
  3689. - unsigned size
  3690. - unsigned checksum
  3691. <a name="Class_PackageFile"></a>
  3692. ### PackageFile : Object
  3693. Methods:
  3694. - PackageFile() (GC)
  3695. - PackageFile* new()
  3696. - PackageFile(const String fileName, unsigned startOffset = 0) (GC)
  3697. - PackageFile* new(const String fileName, unsigned startOffset = 0)
  3698. - void delete()
  3699. - bool Open(const String fileName, unsigned startOffset = 0)
  3700. - bool Exists(const String fileName) const
  3701. - const PackageEntry* GetEntry(const String fileName) const
  3702. - const HashMap<String,PackageEntry>& GetEntries() const
  3703. - const String GetName() const
  3704. - StringHash GetNameHash() const
  3705. - unsigned GetNumFiles() const
  3706. - unsigned GetTotalSize() const
  3707. - unsigned GetTotalDataSize() const
  3708. - unsigned GetChecksum() const
  3709. - bool IsCompressed() const
  3710. Properties:
  3711. - String name (readonly)
  3712. - StringHash nameHash (readonly)
  3713. - unsigned numFiles (readonly)
  3714. - unsigned totalSize (readonly)
  3715. - unsigned totalDataSize (readonly)
  3716. - unsigned checksum (readonly)
  3717. - bool compressed (readonly)
  3718. <a name="Class_ParticleEffect"></a>
  3719. ### ParticleEffect : Resource
  3720. Methods:
  3721. - ParticleEffect() (GC)
  3722. - ParticleEffect* new()
  3723. - void delete()
  3724. - void SetMaterial(Material* material)
  3725. - void SetNumParticles(unsigned num)
  3726. - void SetUpdateInvisible(bool enable)
  3727. - void SetRelative(bool enable)
  3728. - void SetScaled(bool enable)
  3729. - void SetSorted(bool enable)
  3730. - void SetFixedScreenSize(bool enable)
  3731. - void SetAnimationLodBias(float lodBias)
  3732. - void SetEmitterType(EmitterType type)
  3733. - void SetEmitterSize(const Vector3& size)
  3734. - void SetMinDirection(const Vector3& direction)
  3735. - void SetMaxDirection(const Vector3& direction)
  3736. - void SetConstantForce(const Vector3& force)
  3737. - void SetDampingForce(float force)
  3738. - void SetActiveTime(float time)
  3739. - void SetInactiveTime(float time)
  3740. - void SetMinEmissionRate(float rate)
  3741. - void SetMaxEmissionRate(float rate)
  3742. - void SetMinParticleSize(const Vector2& size)
  3743. - void SetMaxParticleSize(const Vector2& size)
  3744. - void SetMinTimeToLive(float time)
  3745. - void SetMaxTimeToLive(float time)
  3746. - void SetMinVelocity(float velocity)
  3747. - void SetMaxVelocity(float velocity)
  3748. - void SetMinRotation(float rotation)
  3749. - void SetMaxRotation(float rotation)
  3750. - void SetMinRotationSpeed(float speed)
  3751. - void SetMaxRotationSpeed(float speed)
  3752. - void SetSizeAdd(float sizeAdd)
  3753. - void SetSizeMul(float sizeMul)
  3754. - void AddColorTime(const Color& color, const float time)
  3755. - void AddColorFrame(const ColorFrame& colorFrame)
  3756. - void RemoveColorFrame(unsigned index)
  3757. - void SetColorFrame(unsigned index, const ColorFrame& colorFrame)
  3758. - void SetNumColorFrames(unsigned number)
  3759. - void SortColorFrames()
  3760. - void AddTextureTime(const Rect& uv, const float time)
  3761. - void AddTextureFrame(const TextureFrame& textureFrame)
  3762. - void RemoveTextureFrame(unsigned index)
  3763. - void SetTextureFrame(unsigned index, const TextureFrame& textureFrame)
  3764. - void SetNumTextureFrames(unsigned number)
  3765. - void SortTextureFrames()
  3766. - ParticleEffect* Clone(const String cloneName = String::EMPTY) const
  3767. - Material* GetMaterial() const
  3768. - unsigned GetNumParticles() const
  3769. - bool GetUpdateInvisible() const
  3770. - bool IsRelative() const
  3771. - bool IsScaled() const
  3772. - bool IsSorted() const
  3773. - bool IsFixedScreenSize() const
  3774. - float GetAnimationLodBias() const
  3775. - EmitterType GetEmitterType() const
  3776. - const Vector3& GetEmitterSize() const
  3777. - const Vector3& GetMinDirection() const
  3778. - const Vector3& GetMaxDirection() const
  3779. - const Vector3& GetConstantForce() const
  3780. - float GetDampingForce() const
  3781. - float GetActiveTime() const
  3782. - float GetInactiveTime() const
  3783. - float GetMinEmissionRate() const
  3784. - float GetMaxEmissionRate() const
  3785. - const Vector2& GetMinParticleSize() const
  3786. - const Vector2& GetMaxParticleSize() const
  3787. - float GetMinTimeToLive() const
  3788. - float GetMaxTimeToLive() const
  3789. - float GetMinVelocity() const
  3790. - float GetMaxVelocity() const
  3791. - float GetMinRotation() const
  3792. - float GetMaxRotation() const
  3793. - float GetMinRotationSpeed() const
  3794. - float GetMaxRotationSpeed() const
  3795. - float GetSizeAdd() const
  3796. - float GetSizeMul() const
  3797. - unsigned GetNumColorFrames() const
  3798. - const ColorFrame* GetColorFrame(unsigned index) const
  3799. - unsigned GetNumTextureFrames() const
  3800. - const TextureFrame* GetTextureFrame(unsigned index) const
  3801. Properties:
  3802. - Material* material
  3803. - unsigned numParticles
  3804. - bool updateInvisible
  3805. - bool relative
  3806. - bool scaled
  3807. - bool sorted
  3808. - bool fixedScreenSize
  3809. - float animationLodBias
  3810. - EmitterType emitterType
  3811. - const Vector3& emitterSize
  3812. - const Vector3& minDirection
  3813. - const Vector3& maxDirection
  3814. - const Vector3& constantForce
  3815. - float dampingForce
  3816. - float activeTime
  3817. - float inactiveTime
  3818. - float minEmissionRate
  3819. - float maxEmissionRate
  3820. - const Vector2& minParticleSize
  3821. - const Vector2& maxParticleSize
  3822. - float minTimeToLive
  3823. - float maxTimeToLive
  3824. - float minVelocity
  3825. - float maxVelocity
  3826. - float minRotation
  3827. - float maxRotation
  3828. - float minRotationSpeed
  3829. - float maxRotationSpeed
  3830. - float sizeAdd
  3831. - float sizeMul
  3832. - unsigned numColorFrames
  3833. - unsigned numTextureFrames
  3834. <a name="Class_ParticleEffect2D"></a>
  3835. ### ParticleEffect2D : Resource
  3836. Methods:
  3837. - ParticleEffect2D* Clone(const String cloneName = String::EMPTY) const
  3838. <a name="Class_ParticleEmitter"></a>
  3839. ### ParticleEmitter : BillboardSet
  3840. Methods:
  3841. - void SetEffect(ParticleEffect* effect)
  3842. - void SetNumParticles(unsigned num)
  3843. - void SetEmitting(bool enable)
  3844. - void SetSerializeParticles(bool enable)
  3845. - void SetAutoRemoveMode(AutoRemoveMode mode)
  3846. - void ResetEmissionTimer()
  3847. - void RemoveAllParticles()
  3848. - void Reset()
  3849. - void ApplyEffect()
  3850. - ParticleEffect* GetEffect() const
  3851. - unsigned GetNumParticles() const
  3852. - bool IsEmitting() const
  3853. - bool GetSerializeParticles() const
  3854. - AutoRemoveMode GetAutoRemoveMode() const
  3855. Properties:
  3856. - ParticleEffect* effect
  3857. - unsigned numParticles
  3858. - bool emitting
  3859. - bool serializeParticles
  3860. - AutoRemoveMode autoRemoveMode
  3861. <a name="Class_ParticleEmitter2D"></a>
  3862. ### ParticleEmitter2D : Drawable2D
  3863. Methods:
  3864. - void SetEffect(ParticleEffect2D* effect)
  3865. - void SetSprite(Sprite2D* sprite)
  3866. - void SetBlendMode(BlendMode blendMode)
  3867. - ParticleEffect2D* GetEffect() const
  3868. - Sprite2D* GetSprite() const
  3869. - BlendMode GetBlendMode() const
  3870. Properties:
  3871. - ParticleEffect2D* effect
  3872. - Sprite2D* sprite
  3873. - BlendMode blendMode
  3874. <a name="Class_Pass"></a>
  3875. ### Pass : RefCounted
  3876. Methods:
  3877. - void SetBlendMode(BlendMode mode)
  3878. - void SetCullMode(CullMode mode)
  3879. - void SetDepthTestMode(CompareMode mode)
  3880. - void SetLightingMode(PassLightingMode mode)
  3881. - void SetDepthWrite(bool enable)
  3882. - void SetAlphaToCoverage(bool enable)
  3883. - void SetIsDesktop(bool enable)
  3884. - void SetVertexShader(const String name)
  3885. - void SetPixelShader(const String name)
  3886. - void SetVertexShaderDefines(const String defines)
  3887. - void SetPixelShaderDefines(const String defines)
  3888. - void SetVertexShaderDefineExcludes(const String excludes)
  3889. - void SetPixelShaderDefineExcludes(const String excludes)
  3890. - void ReleaseShaders()
  3891. - const String GetName() const
  3892. - unsigned GetIndex() const
  3893. - CullMode GetCullMode() const
  3894. - BlendMode GetBlendMode() const
  3895. - CompareMode GetDepthTestMode() const
  3896. - PassLightingMode GetLightingMode() const
  3897. - bool GetDepthWrite() const
  3898. - bool GetAlphaToCoverage() const
  3899. - bool IsDesktop() const
  3900. - const String GetVertexShader() const
  3901. - const String GetPixelShader() const
  3902. - const String GetVertexShaderDefines() const
  3903. - const String GetPixelShaderDefines() const
  3904. - const String GetVertexShaderDefineExcludes() const
  3905. - const String GetPixelShaderDefineExcludes() const
  3906. Properties:
  3907. - String name (readonly)
  3908. - unsigned index (readonly)
  3909. - BlendMode blendMode
  3910. - CullMode cullMode
  3911. - CompareMode depthTestMode
  3912. - PassLightingMode lightingMode
  3913. - bool depthWrite
  3914. - bool alphaToCoverage
  3915. - bool desktop (readonly)
  3916. - String vertexShader
  3917. - String pixelShader
  3918. - String vertexShaderDefines
  3919. - String pixelShaderDefines
  3920. - String vertexShaderDefineExcludes
  3921. - String pixelShaderDefineExcludes
  3922. <a name="Class_PhysicsRaycastResult"></a>
  3923. ### PhysicsRaycastResult
  3924. Methods:
  3925. - PhysicsRaycastResult() (GC)
  3926. - PhysicsRaycastResult* new()
  3927. - void delete()
  3928. Properties:
  3929. - Vector3 position
  3930. - Vector3 normal
  3931. - float distance
  3932. - float hitFraction
  3933. - RigidBody* body
  3934. <a name="Class_PhysicsRaycastResult2D"></a>
  3935. ### PhysicsRaycastResult2D
  3936. Methods:
  3937. - PhysicsRaycastResult2D() (GC)
  3938. - PhysicsRaycastResult2D* new()
  3939. - void delete()
  3940. Properties:
  3941. - Vector2 position
  3942. - Vector2 normal
  3943. - float distance
  3944. - RigidBody2D* body
  3945. <a name="Class_PhysicsWorld"></a>
  3946. ### PhysicsWorld : Component
  3947. Methods:
  3948. - void Update(float timeStep)
  3949. - void UpdateCollisions()
  3950. - void SetFps(int fps)
  3951. - void SetGravity(const Vector3& gravity)
  3952. - void SetMaxSubSteps(int num)
  3953. - void SetNumIterations(int num)
  3954. - void SetUpdateEnabled(bool enable)
  3955. - void SetInterpolation(bool enable)
  3956. - void SetInternalEdge(bool enable)
  3957. - void SetSplitImpulse(bool enable)
  3958. - void SetMaxNetworkAngularVelocity(float velocity)
  3959. - const PODVector<PhysicsRaycastResult>& Raycast(const Ray& ray, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  3960. - PhysicsRaycastResult RaycastSingle(const Ray& ray, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  3961. - PhysicsRaycastResult RaycastSingleSegmented(const Ray& ray, float maxDistance, float segmentDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  3962. - PhysicsRaycastResult SphereCast(const Ray& ray, float radius, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  3963. - PhysicsRaycastResult ConvexCast(CollisionShape* shape, const Vector3& startPos, const Quaternion& startRot, const Vector3& endPos, const Quaternion& endRot, unsigned collisionMask = M_MAX_UNSIGNED)
  3964. - const PODVector<RigidBody*>& GetRigidBodies(const Sphere& sphere, unsigned collisionMask = M_MAX_UNSIGNED)
  3965. - const PODVector<RigidBody*>& GetRigidBodies(const BoundingBox& box, unsigned collisionMask = M_MAX_UNSIGNED)
  3966. - const PODVector<RigidBody*>& GetRigidBodies(const RigidBody* body)
  3967. - const PODVector<RigidBody*>& GetCollidingBodies(const RigidBody* body)
  3968. - void DrawDebugGeometry(bool depthTest)
  3969. - void RemoveCachedGeometry(Model* model)
  3970. - Vector3 GetGravity() const
  3971. - int GetMaxSubSteps() const
  3972. - int GetNumIterations() const
  3973. - bool IsUpdateEnabled() const
  3974. - bool GetInterpolation() const
  3975. - bool GetInternalEdge() const
  3976. - bool GetSplitImpulse() const
  3977. - int GetFps() const
  3978. - float GetMaxNetworkAngularVelocity() const
  3979. Properties:
  3980. - Vector3 gravity
  3981. - int maxSubSteps
  3982. - int numIterations
  3983. - bool updateEnabled
  3984. - bool interpolation
  3985. - bool internalEdge
  3986. - bool splitImpulse
  3987. - int fps
  3988. - float maxNetworkAngularVelocity
  3989. <a name="Class_PhysicsWorld2D"></a>
  3990. ### PhysicsWorld2D : Component
  3991. Methods:
  3992. - void DrawDebugGeometry()
  3993. - void SetUpdateEnabled(bool enable)
  3994. - void SetDrawShape(bool drawShape)
  3995. - void SetDrawJoint(bool drawJoint)
  3996. - void SetDrawAabb(bool drawAabb)
  3997. - void SetDrawPair(bool drawPair)
  3998. - void SetDrawCenterOfMass(bool drawCenterOfMass)
  3999. - void SetAllowSleeping(bool enable)
  4000. - void SetWarmStarting(bool enable)
  4001. - void SetContinuousPhysics(bool enable)
  4002. - void SetSubStepping(bool enable)
  4003. - void SetGravity(const Vector2& gravity)
  4004. - void SetAutoClearForces(bool enable)
  4005. - void SetVelocityIterations(int velocityIterations)
  4006. - void SetPositionIterations(int positionIterations)
  4007. - const PODVector<PhysicsRaycastResult2D>& Raycast(const Vector2& startPoint, const Vector2& endPoint, unsigned collisionMask = M_MAX_UNSIGNED)
  4008. - PhysicsRaycastResult2D RaycastSingle(const Vector2& startPoint, const Vector2& endPoint, unsigned collisionMask = M_MAX_UNSIGNED)
  4009. - RigidBody2D* GetRigidBody(const Vector2& point, unsigned collisionMask = M_MAX_UNSIGNED)
  4010. - RigidBody2D* GetRigidBody(int screenX, int screenY, unsigned collisionMask = M_MAX_UNSIGNED)
  4011. - const PODVector<RigidBody2D*>& GetRigidBodies(const Rect& aabb, unsigned collisionMask = M_MAX_UNSIGNED)
  4012. - bool IsUpdateEnabled() const
  4013. - bool GetDrawShape() const
  4014. - bool GetDrawJoint() const
  4015. - bool GetDrawAabb() const
  4016. - bool GetDrawPair() const
  4017. - bool GetDrawCenterOfMass() const
  4018. - bool GetAllowSleeping() const
  4019. - bool GetWarmStarting() const
  4020. - bool GetContinuousPhysics() const
  4021. - bool GetSubStepping() const
  4022. - bool GetAutoClearForces() const
  4023. - const Vector2& GetGravity() const
  4024. - int GetVelocityIterations() const
  4025. - int GetPositionIterations() const
  4026. Properties:
  4027. - bool updateEnabled
  4028. - bool drawShape
  4029. - bool drawJoint
  4030. - bool drawAabb
  4031. - bool drawPair
  4032. - bool drawCenterOfMass
  4033. - bool allowSleeping
  4034. - bool warmStarting
  4035. - bool continuousPhysics
  4036. - bool subStepping
  4037. - bool autoClearForces
  4038. - Vector2& gravity
  4039. - int velocityIterations
  4040. - int positionIterations
  4041. <a name="Class_Plane"></a>
  4042. ### Plane
  4043. Methods:
  4044. - Plane() (GC)
  4045. - Plane* new()
  4046. - Plane(const Plane& plane) (GC)
  4047. - Plane* new(const Plane& plane)
  4048. - Plane(const Vector3& v0, const Vector3& v1, const Vector3& v2) (GC)
  4049. - Plane* new(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  4050. - Plane(const Vector3& normal, const Vector3& point) (GC)
  4051. - Plane* new(const Vector3& normal, const Vector3& point)
  4052. - Plane(const Vector4& plane) (GC)
  4053. - Plane* new(const Vector4& plane)
  4054. - void delete()
  4055. - void Define(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  4056. - void Define(const Vector3& normal, const Vector3& point)
  4057. - void Define(const Vector4& plane)
  4058. - void Transform(const Matrix3& transform)
  4059. - void Transform(const Matrix3x4& transform)
  4060. - void Transform(const Matrix4& transform)
  4061. - Vector3 Project(const Vector3& point) const
  4062. - float Distance(const Vector3& point) const
  4063. - Vector3 Reflect(const Vector3& direction) const
  4064. - Matrix3x4 ReflectionMatrix() const
  4065. - Plane Transformed(const Matrix3& transform) const
  4066. - Plane Transformed(const Matrix3x4& transform) const
  4067. - Plane Transformed(const Matrix4& transform) const
  4068. - Vector4 ToVector4() const
  4069. Properties:
  4070. - Vector3 normal
  4071. - Vector3 absNormal
  4072. - float d
  4073. - const Plane UP
  4074. <a name="Class_Polyhedron"></a>
  4075. ### Polyhedron
  4076. Methods:
  4077. - Polyhedron() (GC)
  4078. - Polyhedron* new()
  4079. - Polyhedron(const Polyhedron& polyhedron) (GC)
  4080. - Polyhedron* new(const Polyhedron& polyhedron)
  4081. - Polyhedron(const BoundingBox& box) (GC)
  4082. - Polyhedron* new(const BoundingBox& box)
  4083. - Polyhedron(const Frustum& frustum) (GC)
  4084. - Polyhedron* new(const Frustum& frustum)
  4085. - void delete()
  4086. - void Define(const BoundingBox& box)
  4087. - void Define(const Frustum& frustum)
  4088. - void AddFace(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  4089. - void AddFace(const Vector3& v0, const Vector3& v1, const Vector3& v2, const Vector3& v3)
  4090. - void Clip(const Plane& plane)
  4091. - void Clip(const BoundingBox& box)
  4092. - void Clip(const Frustum& box)
  4093. - void Clear()
  4094. - void Transform(const Matrix3& transform)
  4095. - void Transform(const Matrix3x4& transform)
  4096. - Polyhedron Transformed(const Matrix3& transform) const
  4097. - Polyhedron Transformed(const Matrix3x4& transform) const
  4098. - bool Empty() const
  4099. Properties:
  4100. - bool empty (readonly)
  4101. <a name="Class_ProgressBar"></a>
  4102. ### ProgressBar : BorderImage
  4103. Methods:
  4104. - ProgressBar() (GC)
  4105. - ProgressBar* new()
  4106. - void delete()
  4107. - void SetOrientation(Orientation orientation)
  4108. - void SetRange(float range)
  4109. - void SetValue(float value)
  4110. - void ChangeValue(float delta)
  4111. - void SetLoadingPercentStyle(const String style)
  4112. - void SetShowPercentText(bool showPercentText)
  4113. - Orientation GetOrientation() const
  4114. - float GetRange() const
  4115. - float GetValue() const
  4116. - BorderImage* GetKnob() const
  4117. - const String GetLoadingPercentStyle()
  4118. - bool GetShowPercentText() const
  4119. Properties:
  4120. - Orientation orientation
  4121. - float range
  4122. - float value
  4123. - BorderImage* knob (readonly)
  4124. - String loadingPercentStyle (readonly)
  4125. - bool showPercentText
  4126. <a name="Class_PropertySet2D"></a>
  4127. ### PropertySet2D
  4128. Methods:
  4129. - bool HasProperty(const String name) const
  4130. - const String GetProperty(const String name) const
  4131. <a name="Class_Quaternion"></a>
  4132. ### Quaternion
  4133. Methods:
  4134. - Quaternion() (GC)
  4135. - Quaternion* new()
  4136. - Quaternion(const Quaternion& quat) (GC)
  4137. - Quaternion* new(const Quaternion& quat)
  4138. - Quaternion(float w, float x, float y, float z) (GC)
  4139. - Quaternion* new(float w, float x, float y, float z)
  4140. - Quaternion(float angle, const Vector3& axis) (GC)
  4141. - Quaternion* new(float angle, const Vector3& axis)
  4142. - Quaternion(float angle) (GC)
  4143. - Quaternion* new(float angle)
  4144. - Quaternion(float x, float y, float z) (GC)
  4145. - Quaternion* new(float x, float y, float z)
  4146. - Quaternion(const Vector3& start, const Vector3& end) (GC)
  4147. - Quaternion* new(const Vector3& start, const Vector3& end)
  4148. - Quaternion(const Vector3& xAxis, const Vector3& yAxis, const Vector3& zAxis) (GC)
  4149. - Quaternion* new(const Vector3& xAxis, const Vector3& yAxis, const Vector3& zAxis)
  4150. - Quaternion(const Matrix3& matrix) (GC)
  4151. - Quaternion* new(const Matrix3& matrix)
  4152. - void delete()
  4153. - bool operator==(const Quaternion& rhs) const
  4154. - Quaternion operator*(float rhs) const
  4155. - Quaternion operator-() const
  4156. - bool operator==(const Quaternion& rhs) const
  4157. - Quaternion operator*(float rhs) const
  4158. - Quaternion operator-() const
  4159. - Quaternion operator+(const Quaternion& rhs) const
  4160. - Quaternion operator-(const Quaternion& rhs) const
  4161. - Quaternion operator*(const Quaternion& rhs) const
  4162. - Vector3 operator*(const Vector3& rhs) const
  4163. - void FromAngleAxis(float angle, const Vector3& axis)
  4164. - void FromEulerAngles(float x, float y, float z)
  4165. - void FromRotationTo(const Vector3& start, const Vector3& end)
  4166. - void FromAxes(const Vector3& xAxis, const Vector3& yAxis, const Vector3& zAxis)
  4167. - void FromRotationMatrix(const Matrix3& matrix)
  4168. - bool FromLookRotation(const Vector3& direction, const Vector3& up)
  4169. - void Normalize()
  4170. - Quaternion Normalized() const
  4171. - Quaternion Inverse() const
  4172. - float LengthSquared() const
  4173. - float DotProduct(const Quaternion& rhs) const
  4174. - bool Equals(const Quaternion& rhs) const
  4175. - bool IsNaN() const
  4176. - Quaternion Conjugate() const
  4177. - Vector3 EulerAngles() const
  4178. - float YawAngle() const
  4179. - float PitchAngle() const
  4180. - float RollAngle() const
  4181. - Matrix3 RotationMatrix() const
  4182. - Quaternion Slerp(Quaternion rhs, float t) const
  4183. - Quaternion Nlerp(Quaternion rhs, float t, bool shortestPath) const
  4184. - String ToString() const
  4185. Properties:
  4186. - float w
  4187. - float x
  4188. - float y
  4189. - float z
  4190. - const Quaternion IDENTITY
  4191. <a name="Class_Ray"></a>
  4192. ### Ray
  4193. Methods:
  4194. - Ray() (GC)
  4195. - Ray* new()
  4196. - Ray(const Vector3& origin, const Vector3& direction) (GC)
  4197. - Ray* new(const Vector3& origin, const Vector3& direction)
  4198. - Ray(const Ray& ray) (GC)
  4199. - Ray* new(const Ray& ray)
  4200. - void delete()
  4201. - bool operator==(const Ray& rhs) const
  4202. - void Define(const Vector3& origin, const Vector3& direction)
  4203. - Vector3 Project(const Vector3& point) const
  4204. - float Distance(const Vector3& point) const
  4205. - Vector3 ClosestPoint(const Ray& ray) const
  4206. - float HitDistance(const Plane& plane) const
  4207. - float HitDistance(const BoundingBox& box) const
  4208. - float HitDistance(const Frustum& frustum, bool solidInside = true) const
  4209. - float HitDistance(const Sphere& sphere) const
  4210. - float HitDistance(const Vector3& v0, const Vector3& v1, const Vector3& v2) const
  4211. - Ray Transformed(const Matrix3x4& transform) const
  4212. Properties:
  4213. - Vector3 origin
  4214. - Vector3 direction
  4215. <a name="Class_RayQueryResult"></a>
  4216. ### RayQueryResult
  4217. Methods:
  4218. - RayQueryResult() (GC)
  4219. - RayQueryResult* new()
  4220. - void delete()
  4221. Properties:
  4222. - Vector3 position
  4223. - Vector3 normal
  4224. - Vector2 textureUV
  4225. - float distance
  4226. - Drawable* drawable
  4227. - Node* node
  4228. - unsigned subObject
  4229. <a name="Class_Rect"></a>
  4230. ### Rect
  4231. Methods:
  4232. - Rect() (GC)
  4233. - Rect* new()
  4234. - Rect(const Rect& rect) (GC)
  4235. - Rect* new(const Rect& rect)
  4236. - Rect(const Vector2& min, const Vector2& max) (GC)
  4237. - Rect* new(const Vector2& min, const Vector2& max)
  4238. - Rect(float left, float top, float right, float bottom) (GC)
  4239. - Rect* new(float left, float top, float right, float bottom)
  4240. - Rect(const Vector4& vector) (GC)
  4241. - Rect* new(const Vector4& vector)
  4242. - void delete()
  4243. - bool operator==(const Rect& rhs) const
  4244. - void Define(const Rect& rect)
  4245. - void Define(const Vector2& min, const Vector2& max)
  4246. - void Define(const Vector2& point)
  4247. - void Merge(const Vector2& point)
  4248. - void Merge(const Rect& rect)
  4249. - void Clear()
  4250. - void Clip(const Rect& rect)
  4251. - bool Defined() const
  4252. - Vector2 Center() const
  4253. - Vector2 Size() const
  4254. - Vector2 HalfSize() const
  4255. - bool Equals(const Rect& rhs) const
  4256. - Intersection IsInside(const Vector2& point) const
  4257. - Intersection IsInside(const Rect& rect) const
  4258. - Vector4 ToVector4() const
  4259. - String ToString() const
  4260. Properties:
  4261. - Vector2 min
  4262. - Vector2 max
  4263. - const Rect FULL
  4264. - const Rect POSITIVE
  4265. - const Rect ZERO
  4266. - Vector2 center (readonly)
  4267. - Vector2 size (readonly)
  4268. - Vector2 halfSize (readonly)
  4269. <a name="Class_RemoteEvent"></a>
  4270. ### RemoteEvent
  4271. Properties:
  4272. - unsigned senderID
  4273. - StringHash eventType
  4274. - VariantMap eventData
  4275. - bool inOrder
  4276. <a name="Class_RenderPath"></a>
  4277. ### RenderPath
  4278. Methods:
  4279. - RenderPath* Clone()
  4280. - bool Load(XMLFile* file)
  4281. - bool Append(XMLFile* file)
  4282. - void SetEnabled(const String tag, bool active)
  4283. - void ToggleEnabled(const String tag)
  4284. - void SetRenderTarget(unsigned index, const RenderTargetInfo& info)
  4285. - void AddRenderTarget(const RenderTargetInfo& info)
  4286. - void RemoveRenderTarget(const String name)
  4287. - void RemoveRenderTarget(unsigned index)
  4288. - void RemoveRenderTargets(const String tag)
  4289. - void SetCommand(unsigned index, const RenderPathCommand& command)
  4290. - void AddCommand(const RenderPathCommand& command)
  4291. - void InsertCommand(unsigned index, const RenderPathCommand& command)
  4292. - void RemoveCommand(unsigned index)
  4293. - void RemoveCommands(const String tag)
  4294. - void SetShaderParameter(const String name, const Variant& value)
  4295. - unsigned GetNumRenderTargets() const
  4296. - unsigned GetNumCommands() const
  4297. - RenderPathCommand* GetCommand(unsigned index)
  4298. - const Variant& GetShaderParameter(const String name) const
  4299. <a name="Class_RenderPathCommand"></a>
  4300. ### RenderPathCommand
  4301. Methods:
  4302. - RenderPathCommand() (GC)
  4303. - RenderPathCommand* new()
  4304. - void Load(const XMLElement& element)
  4305. - void SetTextureName(TextureUnit unit, const String name)
  4306. - void SetShaderParameter(const String name, const Variant& value)
  4307. - void RemoveShaderParameter(const String name)
  4308. - void SetNumOutputs(unsigned num)
  4309. - void SetOutput(unsigned index, const String name, CubeMapFace face)
  4310. - void SetOutputName(unsigned index, const String name)
  4311. - void SetOutputFace(unsigned index, CubeMapFace face)
  4312. - void SetDepthStencilName(const String name)
  4313. - const String GetTextureName(TextureUnit unit) const
  4314. - const Variant& GetShaderParameter(const String name) const
  4315. - unsigned GetNumOutputs() const
  4316. - const String GetOutputName(unsigned index) const
  4317. - CubeMapFace GetOutputFace(unsigned index) const
  4318. - const String GetDepthStencilName() const
  4319. Properties:
  4320. - String tag
  4321. - RenderCommandType type
  4322. - RenderCommandSortMode sortMode
  4323. - String pass
  4324. - String metadata
  4325. - String vertexShaderName
  4326. - String pixelShaderName
  4327. - String vertexShaderDefines
  4328. - String pixelShaderDefines
  4329. - unsigned clearFlags
  4330. - Color clearColor
  4331. - float clearDepth
  4332. - unsigned clearStencil
  4333. - BlendMode blendMode
  4334. - bool enabled
  4335. - bool useFogColor
  4336. - bool markToStencil
  4337. - bool useLitBase
  4338. - bool vertexLights
  4339. - String eventName
  4340. <a name="Class_RenderSurface"></a>
  4341. ### RenderSurface
  4342. Methods:
  4343. - RenderSurface(Texture* parentTexture) (GC)
  4344. - RenderSurface* new(Texture* parentTexture)
  4345. - void delete()
  4346. - void SetNumViewports(unsigned num)
  4347. - void SetViewport(unsigned index, Viewport* viewport)
  4348. - void SetUpdateMode(RenderSurfaceUpdateMode mode)
  4349. - void SetLinkedRenderTarget(RenderSurface* renderTarget)
  4350. - void SetLinkedDepthStencil(RenderSurface* depthStencil)
  4351. - void QueueUpdate()
  4352. - void Release()
  4353. - Texture* GetParentTexture() const
  4354. - int GetWidth() const
  4355. - int GetHeight() const
  4356. - TextureUsage GetUsage() const
  4357. - unsigned GetNumViewports() const
  4358. - Viewport* GetViewport(unsigned index) const
  4359. - RenderSurfaceUpdateMode GetUpdateMode() const
  4360. - RenderSurface* GetLinkedRenderTarget() const
  4361. - RenderSurface* GetLinkedDepthStencil() const
  4362. - bool IsResolveDirty() const
  4363. Properties:
  4364. - Texture* parentTexture (readonly)
  4365. - int width (readonly)
  4366. - int height (readonly)
  4367. - TextureUsage usage (readonly)
  4368. - unsigned numViewports
  4369. - RenderSurfaceUpdateMode updateMode
  4370. - RenderSurface* linkedRenderTarget
  4371. - RenderSurface* linkedDepthStencil
  4372. - bool resolveDirty (readonly)
  4373. <a name="Class_RenderTargetInfo"></a>
  4374. ### RenderTargetInfo
  4375. Methods:
  4376. - RenderTargetInfo() (GC)
  4377. - RenderTargetInfo* new()
  4378. - void Load(const XMLElement& element)
  4379. Properties:
  4380. - String name
  4381. - String tag
  4382. - unsigned format
  4383. - Vector2 size
  4384. - RenderTargetSizeMode sizeMode
  4385. - int multiSample
  4386. - bool autoResolve
  4387. - bool enabled
  4388. - bool cubemap
  4389. - bool filtered
  4390. - bool sRGB
  4391. - bool persistent
  4392. <a name="Class_Renderer"></a>
  4393. ### Renderer
  4394. Methods:
  4395. - void SetNumViewports(unsigned num)
  4396. - void SetViewport(unsigned index, Viewport* viewport)
  4397. - void SetDefaultRenderPath(RenderPath* renderPath)
  4398. - void SetDefaultRenderPath(XMLFile* file)
  4399. - void SetDefaultTechnique(Technique* technique)
  4400. - void SetHDRRendering(bool enable)
  4401. - void SetSpecularLighting(bool enable)
  4402. - void SetTextureAnisotropy(int level)
  4403. - void SetTextureFilterMode(TextureFilterMode mode)
  4404. - void SetTextureQuality(int quality)
  4405. - void SetMaterialQuality(int quality)
  4406. - void SetDrawShadows(bool enable)
  4407. - void SetShadowMapSize(int size)
  4408. - void SetShadowQuality(ShadowQuality quality)
  4409. - void SetShadowSoftness(float shadowSoftness)
  4410. - void SetVSMShadowParameters(float minVariance, float lightBleedingReduction)
  4411. - void SetVSMMultiSample(int multiSample)
  4412. - void SetReuseShadowMaps(bool enable)
  4413. - void SetMaxShadowMaps(int shadowMaps)
  4414. - void SetDynamicInstancing(bool enable)
  4415. - void SetNumExtraInstancingBufferElements(int elements)
  4416. - void SetMinInstances(int instances)
  4417. - void SetMaxSortedInstances(int instances)
  4418. - void SetMaxOccluderTriangles(int triangles)
  4419. - void SetOcclusionBufferSize(int size)
  4420. - void SetOccluderSizeThreshold(float screenSize)
  4421. - void SetThreadedOcclusion(bool enable)
  4422. - void SetMobileShadowBiasMul(float mul)
  4423. - void SetMobileShadowBiasAdd(float add)
  4424. - void SetMobileNormalOffsetMul(float mul)
  4425. - void ReloadShaders()
  4426. - unsigned GetNumViewports() const
  4427. - Viewport* GetViewport(unsigned index) const
  4428. - RenderPath* GetDefaultRenderPath() const
  4429. - Technique* GetDefaultTechnique() const
  4430. - bool GetHDRRendering() const
  4431. - bool GetSpecularLighting() const
  4432. - bool GetDrawShadows() const
  4433. - int GetTextureAnisotropy() const
  4434. - TextureFilterMode GetTextureFilterMode() const
  4435. - int GetTextureQuality() const
  4436. - int GetMaterialQuality() const
  4437. - int GetShadowMapSize() const
  4438. - ShadowQuality GetShadowQuality() const
  4439. - float GetShadowSoftness() const
  4440. - Vector2 GetVSMShadowParameters() const
  4441. - int GetVSMMultiSample() const
  4442. - bool GetReuseShadowMaps() const
  4443. - int GetMaxShadowMaps() const
  4444. - bool GetDynamicInstancing() const
  4445. - int GetNumExtraInstancingBufferElements() const
  4446. - int GetMinInstances() const
  4447. - int GetMaxSortedInstances() const
  4448. - int GetMaxOccluderTriangles() const
  4449. - int GetOcclusionBufferSize() const
  4450. - float GetOccluderSizeThreshold() const
  4451. - bool GetThreadedOcclusion() const
  4452. - float GetMobileShadowBiasMul() const
  4453. - float GetMobileShadowBiasAdd() const
  4454. - float GetMobileNormalOffsetMul() const
  4455. - unsigned GetNumViews() const
  4456. - unsigned GetNumPrimitives() const
  4457. - unsigned GetNumBatches() const
  4458. - unsigned GetNumGeometries(bool allViews = false) const
  4459. - unsigned GetNumLights(bool allViews = false) const
  4460. - unsigned GetNumShadowMaps(bool allViews = false) const
  4461. - unsigned GetNumOccluders(bool allViews = false) const
  4462. - Zone* GetDefaultZone() const
  4463. - Material* GetDefaultMaterial() const
  4464. - Texture2D* GetDefaultLightRamp() const
  4465. - Texture2D* GetDefaultLightSpot() const
  4466. - void DrawDebugGeometry(bool depthTest)
  4467. Properties:
  4468. - unsigned numViewports
  4469. - RenderPath* defaultRenderPath
  4470. - Technique* defaultTechnique
  4471. - bool HDRRendering
  4472. - bool specularLighting
  4473. - bool drawShadows
  4474. - int textureAnisotropy
  4475. - TextureFilterMode textureFilterMode
  4476. - int textureQuality
  4477. - int materialQuality
  4478. - int shadowMapSize
  4479. - ShadowQuality shadowQuality
  4480. - float shadowSoftness
  4481. - int VSMMultiSample
  4482. - bool reuseShadowMaps
  4483. - int maxShadowMaps
  4484. - bool dynamicInstancing
  4485. - int numExtraInstancingBufferElements
  4486. - int minInstances
  4487. - int maxSortedInstances
  4488. - int maxOccluderTriangles
  4489. - int occlusionBufferSize
  4490. - float occluderSizeThreshold
  4491. - bool threadedOcclusion
  4492. - float mobileShadowBiasMul
  4493. - float mobileShadowBiasAdd
  4494. - float mobileNormalOffsetMul
  4495. - unsigned numViews (readonly)
  4496. - unsigned numPrimitives (readonly)
  4497. - unsigned numBatches (readonly)
  4498. - Zone* defaultZone (readonly)
  4499. - Material* defaultMaterial (readonly)
  4500. - Texture2D* defaultLightRamp (readonly)
  4501. - Texture2D* defaultLightSpot (readonly)
  4502. <a name="Class_Resource"></a>
  4503. ### Resource
  4504. Methods:
  4505. - bool Load(Deserializer& source)
  4506. - bool Save(Serializer& dest) const
  4507. - bool Load(const String fileName)
  4508. - bool Save(const String fileName) const
  4509. - const String GetName() const
  4510. - StringHash GetNameHash() const
  4511. - unsigned GetMemoryUse() const
  4512. Properties:
  4513. - String name (readonly)
  4514. - StringHash nameHash (readonly)
  4515. - unsigned memoryUse (readonly)
  4516. <a name="Class_ResourceCache"></a>
  4517. ### ResourceCache
  4518. Methods:
  4519. - void ReleaseAllResources(bool force = false)
  4520. - bool ReloadResource(Resource* resource)
  4521. - void ReloadResourceWithDependencies(const String fileName)
  4522. - void SetMemoryBudget(StringHash type, long budget)
  4523. - void SetMemoryBudget(const String type, long budget)
  4524. - void SetAutoReloadResources(bool enable)
  4525. - void SetReturnFailedResources(bool enable)
  4526. - void SetSearchPackagesFirst(bool value)
  4527. - void SetFinishBackgroundResourcesMs(int ms)
  4528. - File* GetFile(const String name)
  4529. - Resource* GetResource(const String type, const String name, bool sendEventOnFailure = true)
  4530. - Resource* GetExistingResource(const String type, const String name)
  4531. - bool BackgroundLoadResource(const String type, const String name, bool sendEventOnFailure = true)
  4532. - unsigned GetNumBackgroundLoadResources() const
  4533. - const Vector<String>& GetResourceDirs() const
  4534. - bool Exists(const String name) const
  4535. - long GetMemoryBudget(StringHash type) const
  4536. - long GetMemoryUse(StringHash type) const
  4537. - long GetTotalMemoryUse() const
  4538. - String GetResourceFileName(const String name) const
  4539. - bool GetAutoReloadResources() const
  4540. - bool GetReturnFailedResources() const
  4541. - bool GetSearchPackagesFirst() const
  4542. - int GetFinishBackgroundResourcesMs() const
  4543. - String GetPreferredResourceDir(const String path) const
  4544. - String SanitateResourceName(const String name) const
  4545. - String SanitateResourceDirName(const String name) const
  4546. Properties:
  4547. - long totalMemoryUse (readonly)
  4548. - bool autoReloadResources
  4549. - bool returnFailedResources
  4550. - bool searchPackagesFirst
  4551. - unsigned numBackgroundLoadResources (readonly)
  4552. - Vector<String>& resourceDirs (readonly)
  4553. - int finishBackgroundResourcesMs
  4554. <a name="Class_ResourceRef"></a>
  4555. ### ResourceRef
  4556. Methods:
  4557. - ResourceRef() (GC)
  4558. - ResourceRef* new()
  4559. - ResourceRef(StringHash type) (GC)
  4560. - ResourceRef* new(StringHash type)
  4561. - ResourceRef(StringHash type, String name) (GC)
  4562. - ResourceRef* new(StringHash type, String name)
  4563. - ResourceRef(String type, String name) (GC)
  4564. - ResourceRef* new(String type, String name)
  4565. - ResourceRef(const ResourceRef& rhs) (GC)
  4566. - ResourceRef* new(const ResourceRef& rhs)
  4567. - void delete()
  4568. - bool operator==(const ResourceRef& rhs) const
  4569. Properties:
  4570. - StringHash type
  4571. - String name
  4572. <a name="Class_ResourceRefList"></a>
  4573. ### ResourceRefList
  4574. Methods:
  4575. - ResourceRefList() (GC)
  4576. - ResourceRefList* new()
  4577. - ResourceRefList(StringHash type) (GC)
  4578. - ResourceRefList* new(StringHash type)
  4579. - void delete()
  4580. - bool operator==(const ResourceRefList& rhs) const
  4581. Properties:
  4582. - StringHash type
  4583. <a name="Class_RibbonTrail"></a>
  4584. ### RibbonTrail : Drawable
  4585. Methods:
  4586. - void SetMaterial(Material* material)
  4587. - void SetVertexDistance(float length)
  4588. - void SetWidth(float width)
  4589. - void SetStartColor(const Color& c)
  4590. - void SetEndColor(const Color& c)
  4591. - void SetStartScale(float startScale)
  4592. - void SetEndScale(float endScale)
  4593. - void SetTrailType(TrailType type)
  4594. - void SetSorted(bool enable)
  4595. - void SetLifetime(float time)
  4596. - void SetEmitting(bool emitting)
  4597. - void SetUpdateInvisible(bool updateInvisible)
  4598. - void SetTailColumn(unsigned tailColumn)
  4599. - void SetAnimationLodBias(float bias)
  4600. - void Commit()
  4601. - Material* GetMaterial() const
  4602. - float GetVertexDistance() const
  4603. - float GetWidth() const
  4604. - const Color& GetStartColor() const
  4605. - const Color& GetEndColor() const
  4606. - float GetStartScale() const
  4607. - float GetEndScale() const
  4608. - TrailType GetTrailType() const
  4609. - bool IsSorted() const
  4610. - float GetLifetime() const
  4611. - unsigned GetTailColumn() const
  4612. - bool IsEmitting() const
  4613. - bool GetUpdateInvisible() const
  4614. - float GetAnimationLodBias() const
  4615. Properties:
  4616. - Material* material
  4617. - float vertexDistance
  4618. - float width
  4619. - Color& startColor
  4620. - Color& endColor
  4621. - float startScale
  4622. - float endScale
  4623. - TrailType trailType
  4624. - bool sorted
  4625. - float lifetime
  4626. - unsigned tailColumn
  4627. - bool emitting
  4628. - bool updateInvisible
  4629. - float animationLodBias
  4630. <a name="Class_RigidBody"></a>
  4631. ### RigidBody : Component
  4632. Methods:
  4633. - void SetMass(float mass)
  4634. - void SetPosition(const Vector3& position)
  4635. - void SetRotation(const Quaternion& rotation)
  4636. - void SetTransform(const Vector3& position, const Quaternion& rotation)
  4637. - void SetLinearVelocity(const Vector3& velocity)
  4638. - void SetLinearFactor(const Vector3& factor)
  4639. - void SetLinearRestThreshold(float threshold)
  4640. - void SetLinearDamping(float damping)
  4641. - void SetAngularVelocity(const Vector3& angularVelocity)
  4642. - void SetAngularFactor(const Vector3& factor)
  4643. - void SetAngularRestThreshold(float threshold)
  4644. - void SetAngularDamping(float factor)
  4645. - void SetFriction(float friction)
  4646. - void SetAnisotropicFriction(const Vector3& friction)
  4647. - void SetRollingFriction(float friction)
  4648. - void SetRestitution(float restitution)
  4649. - void SetContactProcessingThreshold(float threshold)
  4650. - void SetCcdRadius(float radius)
  4651. - void SetCcdMotionThreshold(float threshold)
  4652. - void SetUseGravity(bool enable)
  4653. - void SetGravityOverride(const Vector3& gravity)
  4654. - void SetKinematic(bool enable)
  4655. - void SetTrigger(bool enable)
  4656. - void SetCollisionLayer(unsigned layer)
  4657. - void SetCollisionMask(unsigned mask)
  4658. - void SetCollisionLayerAndMask(unsigned layer, unsigned mask)
  4659. - void SetCollisionEventMode(CollisionEventMode mode)
  4660. - void DisableMassUpdate()
  4661. - void EnableMassUpdate()
  4662. - void ApplyForce(const Vector3& force)
  4663. - void ApplyForce(const Vector3& force, const Vector3& position)
  4664. - void ApplyTorque(const Vector3& torque)
  4665. - void ApplyImpulse(const Vector3& impulse)
  4666. - void ApplyImpulse(const Vector3& impulse, const Vector3& position)
  4667. - void ApplyTorqueImpulse(const Vector3& torque)
  4668. - void ResetForces()
  4669. - void Activate()
  4670. - void ReAddBodyToWorld()
  4671. - PhysicsWorld* GetPhysicsWorld() const
  4672. - float GetMass() const
  4673. - Vector3 GetPosition() const
  4674. - Quaternion GetRotation() const
  4675. - Vector3 GetLinearVelocity() const
  4676. - Vector3 GetLinearFactor() const
  4677. - Vector3 GetVelocityAtPoint(const Vector3& position) const
  4678. - float GetLinearRestThreshold() const
  4679. - float GetLinearDamping() const
  4680. - Vector3 GetAngularVelocity() const
  4681. - Vector3 GetAngularFactor() const
  4682. - float GetAngularRestThreshold() const
  4683. - float GetAngularDamping() const
  4684. - float GetFriction() const
  4685. - Vector3 GetAnisotropicFriction() const
  4686. - float GetRollingFriction() const
  4687. - float GetRestitution() const
  4688. - float GetContactProcessingThreshold() const
  4689. - float GetCcdRadius() const
  4690. - float GetCcdMotionThreshold() const
  4691. - bool GetUseGravity() const
  4692. - const Vector3& GetGravityOverride() const
  4693. - const Vector3& GetCenterOfMass() const
  4694. - bool IsKinematic() const
  4695. - bool IsTrigger() const
  4696. - bool IsActive() const
  4697. - unsigned GetCollisionLayer() const
  4698. - unsigned GetCollisionMask() const
  4699. - CollisionEventMode GetCollisionEventMode() const
  4700. Properties:
  4701. - PhysicsWorld* physicsWorld (readonly)
  4702. - float mass
  4703. - Vector3 position
  4704. - Quaternion rotation
  4705. - Vector3 linearVelocity
  4706. - Vector3 linearFactor
  4707. - float linearRestThreshold
  4708. - float linearDamping
  4709. - Vector3 angularVelocity
  4710. - Vector3 angularFactor
  4711. - float angularRestThreshold
  4712. - float angularDamping
  4713. - float friction
  4714. - Vector3 anisotropicFriction
  4715. - float rollingFriction
  4716. - float restitution
  4717. - float contactProcessingThreshold
  4718. - float ccdRadius
  4719. - float ccdMotionThreshold
  4720. - bool useGravity
  4721. - Vector3& gravityOverride
  4722. - Vector3& centerOfMass (readonly)
  4723. - bool kinematic
  4724. - bool trigger
  4725. - bool active (readonly)
  4726. - unsigned collisionLayer
  4727. - unsigned collisionMask
  4728. - CollisionEventMode collisionEventMode
  4729. <a name="Class_RigidBody2D"></a>
  4730. ### RigidBody2D : Component
  4731. Methods:
  4732. - void SetBodyType(BodyType2D bodyType)
  4733. - void SetMass(float mass)
  4734. - void SetInertia(float inertia)
  4735. - void SetMassCenter(const Vector2& center)
  4736. - void SetUseFixtureMass(bool useFixtureMass)
  4737. - void SetLinearDamping(float linearDamping)
  4738. - void SetAngularDamping(float angularDamping)
  4739. - void SetAllowSleep(bool allowSleep)
  4740. - void SetFixedRotation(bool fixedRotation)
  4741. - void SetBullet(bool bullet)
  4742. - void SetGravityScale(float gravityScale)
  4743. - void SetAwake(bool awake)
  4744. - void SetLinearVelocity(const Vector2& linearVelocity)
  4745. - void SetAngularVelocity(float angularVelocity)
  4746. - void ApplyForce(const Vector2& force, const Vector2& point, bool wake)
  4747. - void ApplyForceToCenter(const Vector2& force, bool wake)
  4748. - void ApplyTorque(float torque, bool wake)
  4749. - void ApplyLinearImpulse(const Vector2& impulse, const Vector2& point, bool wake)
  4750. - void ApplyAngularImpulse(float impulse, bool wake)
  4751. - BodyType2D GetBodyType() const
  4752. - float GetMass() const
  4753. - float GetInertia() const
  4754. - Vector2 GetMassCenter() const
  4755. - bool GetUseFixtureMass() const
  4756. - float GetLinearDamping() const
  4757. - float GetAngularDamping() const
  4758. - bool IsAllowSleep() const
  4759. - bool IsFixedRotation() const
  4760. - bool IsBullet() const
  4761. - float GetGravityScale() const
  4762. - bool IsAwake() const
  4763. - Vector2 GetLinearVelocity() const
  4764. - float GetAngularVelocity() const
  4765. Properties:
  4766. - BodyType2D bodyType
  4767. - float mass
  4768. - float inertia
  4769. - Vector2 massCenter
  4770. - bool useFixtureMass
  4771. - float linearDamping
  4772. - float angularDamping
  4773. - bool allowSleep
  4774. - bool fixedRotation
  4775. - bool bullet
  4776. - float gravityScale
  4777. - bool awake
  4778. - Vector2 linearVelocity
  4779. - float angularVelocity
  4780. <a name="Class_Scene"></a>
  4781. ### Scene : Node
  4782. Methods:
  4783. - Scene() (GC)
  4784. - Scene* new()
  4785. - void delete()
  4786. - bool Load(File* source)
  4787. - bool Save(File* dest) const
  4788. - bool Load(const String fileName)
  4789. - bool Save(const String fileName) const
  4790. - bool LoadXML(File* source)
  4791. - bool SaveXML(File* dest, const String indentation = "\t") const
  4792. - bool LoadXML(const String fileName)
  4793. - bool SaveXML(const String fileName, const String indentation = "\t") const
  4794. - bool LoadJSON(File* source)
  4795. - bool SaveJSON(File* dest, const String indentation = "\t") const
  4796. - bool LoadJSON(const String fileName)
  4797. - bool SaveJSON(const String fileName, const String indentation = "\t") const
  4798. - Node* Instantiate(File* source, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  4799. - Node* Instantiate(const String fileName, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  4800. - Node* InstantiateXML(File* source, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  4801. - Node* InstantiateXML(const String fileName, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  4802. - bool LoadAsync(File* file, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  4803. - bool LoadAsyncXML(File* file, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  4804. - bool LoadAsync(const String fileName, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  4805. - bool LoadAsyncXML(const String fileName, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  4806. - void StopAsyncLoading()
  4807. - void Clear(bool clearReplicated = true, bool clearLocal = true)
  4808. - void SetUpdateEnabled(bool enable)
  4809. - void SetTimeScale(float scale)
  4810. - void SetElapsedTime(float time)
  4811. - void SetSmoothingConstant(float constant)
  4812. - void SetSnapThreshold(float threshold)
  4813. - void SetAsyncLoadingMs(int ms)
  4814. - Node* GetNode(unsigned id) const
  4815. - bool IsUpdateEnabled() const
  4816. - bool IsAsyncLoading() const
  4817. - float GetAsyncProgress() const
  4818. - LoadMode GetAsyncLoadMode() const
  4819. - const String GetFileName() const
  4820. - unsigned GetChecksum() const
  4821. - float GetTimeScale() const
  4822. - float GetElapsedTime() const
  4823. - float GetSmoothingConstant() const
  4824. - float GetSnapThreshold() const
  4825. - int GetAsyncLoadingMs() const
  4826. - const String GetVarName(StringHash hash) const
  4827. - void Update(float timeStep)
  4828. - void BeginThreadedUpdate()
  4829. - void EndThreadedUpdate()
  4830. - void DelayedMarkedDirty(Component* component)
  4831. - bool IsThreadedUpdate() const
  4832. - unsigned GetFreeNodeID(CreateMode mode)
  4833. - unsigned GetFreeComponentID(CreateMode mode)
  4834. - void NodeAdded(Node* node)
  4835. - void NodeRemoved(Node* node)
  4836. - void ComponentAdded(Component* component)
  4837. - void ComponentRemoved(Component* component)
  4838. - void SetVarNamesAttr(const String value)
  4839. - String GetVarNamesAttr() const
  4840. - void PrepareNetworkUpdate()
  4841. - void CleanupConnection(Connection* connection)
  4842. - void MarkNetworkUpdate(Node* node)
  4843. - void MarkNetworkUpdate(Component* component)
  4844. - void MarkReplicationDirty(Node* node)
  4845. - const PODVector<Node*>& GetNodesWithTag(const String tag) const
  4846. Properties:
  4847. - bool updateEnabled
  4848. - bool asyncLoading (readonly)
  4849. - float asyncProgress (readonly)
  4850. - LoadMode asyncLoadMode (readonly)
  4851. - const String fileName
  4852. - unsigned checksum (readonly)
  4853. - float timeScale
  4854. - float elapsedTime
  4855. - float smoothingConstant
  4856. - float snapThreshold
  4857. - int asyncLoadingMs
  4858. - bool threadedUpdate (readonly)
  4859. - String varNamesAttr
  4860. <a name="Class_ScrollBar"></a>
  4861. ### ScrollBar : BorderImage
  4862. Methods:
  4863. - ScrollBar() (GC)
  4864. - ScrollBar* new()
  4865. - void delete()
  4866. - void SetOrientation(Orientation orientation)
  4867. - void SetRange(float range)
  4868. - void SetValue(float value)
  4869. - void ChangeValue(float delta)
  4870. - void SetScrollStep(float step)
  4871. - void SetStepFactor(float factor)
  4872. - void StepBack()
  4873. - void StepForward()
  4874. - Orientation GetOrientation() const
  4875. - float GetRange() const
  4876. - float GetValue() const
  4877. - float GetScrollStep() const
  4878. - float GetStepFactor() const
  4879. - float GetEffectiveScrollStep() const
  4880. - Button* GetBackButton() const
  4881. - Button* GetForwardButton() const
  4882. - Slider* GetSlider() const
  4883. Properties:
  4884. - Orientation orientation
  4885. - float range
  4886. - float value
  4887. - float scrollStep
  4888. - float stepFactor
  4889. - float effectiveScrollStep (readonly)
  4890. - Button* backButton (readonly)
  4891. - Button* forwardButton (readonly)
  4892. - Slider* slider (readonly)
  4893. <a name="Class_ScrollView"></a>
  4894. ### ScrollView : UIElement
  4895. Methods:
  4896. - ScrollView() (GC)
  4897. - ScrollView* new()
  4898. - void delete()
  4899. - void SetContentElement(UIElement* element)
  4900. - void SetViewPosition(const IntVector2& position)
  4901. - void SetViewPosition(int x, int y)
  4902. - void SetScrollBarsVisible(bool horizontal, bool vertical)
  4903. - void SetScrollBarsAutoVisible(bool enable)
  4904. - void SetScrollStep(float step)
  4905. - void SetPageStep(float step)
  4906. - void SetScrollDeceleration(float deceleration)
  4907. - void SetScrollSnapEpsilon(float snap)
  4908. - void SetAutoDisableChildren(bool disable)
  4909. - void SetAutoDisableThreshold(float amount)
  4910. - const IntVector2& GetViewPosition() const
  4911. - UIElement* GetContentElement() const
  4912. - ScrollBar* GetHorizontalScrollBar() const
  4913. - ScrollBar* GetVerticalScrollBar() const
  4914. - BorderImage* GetScrollPanel() const
  4915. - bool GetScrollBarsAutoVisible() const
  4916. - float GetScrollStep() const
  4917. - float GetPageStep() const
  4918. - float GetScrollDeceleration() const
  4919. - float GetScrollSnapEpsilon() const
  4920. - bool GetAutoDisableChildren() const
  4921. - float GetAutoDisableThreshold() const
  4922. Properties:
  4923. - IntVector2& viewPosition
  4924. - UIElement* contentElement
  4925. - ScrollBar* horizontalScrollBar (readonly)
  4926. - ScrollBar* verticalScrollBar (readonly)
  4927. - BorderImage* scrollPanel (readonly)
  4928. - bool scrollBarsAutoVisible
  4929. - float scrollStep
  4930. - float pageStep
  4931. - float scrollDeceleration
  4932. - float scrollSnapEpsilon
  4933. <a name="Class_Serializable"></a>
  4934. ### Serializable : Object
  4935. Methods:
  4936. - void SetTemporary(bool enable)
  4937. - bool IsTemporary() const
  4938. - void SetInterceptNetworkUpdate(const String attributeName, bool enable)
  4939. - bool GetInterceptNetworkUpdate(const String attributeName)
  4940. Properties:
  4941. - bool temporary
  4942. <a name="Class_Serializer"></a>
  4943. ### Serializer
  4944. Methods:
  4945. - unsigned Write(const VectorBuffer& buffer)
  4946. - bool WriteInt(int value)
  4947. - bool WriteInt64(long value)
  4948. - bool WriteShort(short value)
  4949. - bool WriteByte(char value)
  4950. - bool WriteUInt(unsigned value)
  4951. - bool WriteUInt64(long value)
  4952. - bool WriteUShort(short value)
  4953. - bool WriteUByte(char value)
  4954. - bool WriteBool(bool value)
  4955. - bool WriteFloat(float value)
  4956. - bool WriteDouble(double value)
  4957. - bool WriteIntRect(const IntRect& value)
  4958. - bool WriteIntVector2(const IntVector2& value)
  4959. - bool WriteIntVector3(const IntVector3& value)
  4960. - bool WriteRect(const Rect& value)
  4961. - bool WriteVector2(const Vector2& value)
  4962. - bool WriteVector3(const Vector3& value)
  4963. - bool WritePackedVector3(const Vector3& value, float maxAbsCoord)
  4964. - bool WriteVector4(const Vector4& value)
  4965. - bool WriteQuaternion(const Quaternion& value)
  4966. - bool WritePackedQuaternion(const Quaternion& value)
  4967. - bool WriteMatrix3(const Matrix3& value)
  4968. - bool WriteMatrix3x4(const Matrix3x4& value)
  4969. - bool WriteMatrix4(const Matrix4& value)
  4970. - bool WriteColor(const Color& value)
  4971. - bool WriteBoundingBox(const BoundingBox& value)
  4972. - bool WriteString(const String value)
  4973. - bool WriteFileID(const String value)
  4974. - bool WriteStringHash(const StringHash& value)
  4975. - bool WriteBuffer(const VectorBuffer& buffer)
  4976. - bool WriteResourceRef(const ResourceRef& value)
  4977. - bool WriteResourceRefList(const ResourceRefList& value)
  4978. - bool WriteVariant(const Variant& value)
  4979. - bool WriteVariantData(const Variant& value)
  4980. - bool WriteVariantVector(const VariantVector& value)
  4981. - bool WriteVariantMap(const VariantMap& value)
  4982. - bool WriteVLE(unsigned value)
  4983. - bool WriteNetID(unsigned value)
  4984. - bool WriteLine(const String value)
  4985. <a name="Class_Skeleton"></a>
  4986. ### Skeleton
  4987. Methods:
  4988. - unsigned GetNumBones() const
  4989. - Bone* GetRootBone()
  4990. - Bone* GetBone(const String name)
  4991. - Bone* GetBone(unsigned index)
  4992. Properties:
  4993. - unsigned numBones (readonly)
  4994. - Bone* rootBone (readonly)
  4995. <a name="Class_Skybox"></a>
  4996. ### Skybox : StaticModel
  4997. <a name="Class_Slider"></a>
  4998. ### Slider : BorderImage
  4999. Methods:
  5000. - Slider() (GC)
  5001. - Slider* new()
  5002. - void delete()
  5003. - void SetOrientation(Orientation orientation)
  5004. - void SetRange(float range)
  5005. - void SetValue(float value)
  5006. - void ChangeValue(float delta)
  5007. - void SetRepeatRate(float rate)
  5008. - Orientation GetOrientation() const
  5009. - float GetRange() const
  5010. - float GetValue() const
  5011. - BorderImage* GetKnob() const
  5012. - float GetRepeatRate() const
  5013. Properties:
  5014. - Orientation orientation
  5015. - float range
  5016. - float value
  5017. - BorderImage* knob (readonly)
  5018. - float repeatRate
  5019. <a name="Class_Sound"></a>
  5020. ### Sound : Resource
  5021. Methods:
  5022. - Sound() (GC)
  5023. - Sound* new()
  5024. - void delete()
  5025. - bool LoadRaw(Deserializer& source)
  5026. - bool LoadWav(Deserializer& source)
  5027. - bool LoadOggVorbis(Deserializer& source)
  5028. - bool LoadRaw(const String fileName)
  5029. - bool LoadWav(const String fileName)
  5030. - bool LoadOggVorbis(const String fileName)
  5031. - void SetSize(unsigned dataSize)
  5032. - void SetData(const void* data, unsigned dataSize)
  5033. - void SetFormat(unsigned frequency, bool sixteenBit, bool stereo)
  5034. - void SetLooped(bool enable)
  5035. - void SetLoop(unsigned repeatOffset, unsigned endOffset)
  5036. - void FixInterpolation()
  5037. - float GetLength() const
  5038. - unsigned GetDataSize() const
  5039. - unsigned GetSampleSize() const
  5040. - float GetFrequency() const
  5041. - unsigned GetIntFrequency() const
  5042. - bool IsLooped() const
  5043. - bool IsSixteenBit() const
  5044. - bool IsStereo() const
  5045. - bool IsCompressed() const
  5046. Properties:
  5047. - float length (readonly)
  5048. - unsigned dataSize (readonly)
  5049. - unsigned sampleSize (readonly)
  5050. - float frequency (readonly)
  5051. - int intFrequency (readonly)
  5052. - bool looped
  5053. - bool sixteenBit (readonly)
  5054. - bool stereo (readonly)
  5055. - bool compressed (readonly)
  5056. <a name="Class_SoundListener"></a>
  5057. ### SoundListener : Component
  5058. <a name="Class_SoundSource"></a>
  5059. ### SoundSource : Component
  5060. Methods:
  5061. - void Play(Sound* sound)
  5062. - void Play(Sound* sound, float frequency)
  5063. - void Play(Sound* sound, float frequency, float gain)
  5064. - void Play(Sound* sound, float frequency, float gain, float panning)
  5065. - void Stop()
  5066. - void SetSoundType(const String type)
  5067. - void SetFrequency(float frequency)
  5068. - void SetGain(float gain)
  5069. - void SetAttenuation(float attenuation)
  5070. - void SetPanning(float panning)
  5071. - void SetAutoRemoveMode(AutoRemoveMode mode)
  5072. - Sound* GetSound() const
  5073. - String GetSoundType() const
  5074. - float GetTimePosition() const
  5075. - float GetFrequency() const
  5076. - float GetGain() const
  5077. - float GetAttenuation() const
  5078. - float GetPanning() const
  5079. - AutoRemoveMode GetAutoRemoveMode() const
  5080. - bool IsPlaying() const
  5081. Properties:
  5082. - Sound* sound (readonly)
  5083. - String soundType
  5084. - float timePosition (readonly)
  5085. - float frequency
  5086. - float gain
  5087. - float attenuation
  5088. - float panning
  5089. - AutoRemoveMode autoRemoveMode
  5090. - bool playing (readonly)
  5091. <a name="Class_SoundSource3D"></a>
  5092. ### SoundSource3D : SoundSource
  5093. Methods:
  5094. - void SetDistanceAttenuation(float nearDistance, float farDistance, float rolloffFactor)
  5095. - void SetAngleAttenuation(float innerAngle, float outerAngle)
  5096. - void SetNearDistance(float distance)
  5097. - void SetFarDistance(float distance)
  5098. - void SetInnerAngle(float angle)
  5099. - void SetOuterAngle(float angle)
  5100. - void SetRolloffFactor(float factor)
  5101. - void CalculateAttenuation()
  5102. - float GetNearDistance() const
  5103. - float GetFarDistance() const
  5104. - float GetInnerAngle() const
  5105. - float GetOuterAngle() const
  5106. - float RollAngleoffFactor() const
  5107. Properties:
  5108. - float nearDistance
  5109. - float farDistance
  5110. - float innerAngle
  5111. - float outerAngle
  5112. - float rolloffFactor
  5113. <a name="Class_Sphere"></a>
  5114. ### Sphere
  5115. Methods:
  5116. - Sphere() (GC)
  5117. - Sphere* new()
  5118. - Sphere(const Sphere& sphere) (GC)
  5119. - Sphere* new(const Sphere& sphere)
  5120. - Sphere(const Vector3& center, float radius) (GC)
  5121. - Sphere* new(const Vector3& center, float radius)
  5122. - Sphere(const BoundingBox& box) (GC)
  5123. - Sphere* new(const BoundingBox& box)
  5124. - Sphere(const Frustum& frustum) (GC)
  5125. - Sphere* new(const Frustum& frustum)
  5126. - Sphere(const Polyhedron& poly) (GC)
  5127. - Sphere* new(const Polyhedron& poly)
  5128. - void delete()
  5129. - bool operator==(const Sphere& rhs) const
  5130. - void Define(const Sphere& sphere)
  5131. - void Define(const Vector3& center, float radius)
  5132. - void Define(const BoundingBox& box)
  5133. - void Define(const Frustum& frustum)
  5134. - void Define(const Polyhedron& poly)
  5135. - void Merge(const Vector3& point)
  5136. - void Merge(const BoundingBox& box)
  5137. - void Merge(const Frustum& frustum)
  5138. - void Merge(const Polyhedron& poly)
  5139. - void Merge(const Sphere& sphere)
  5140. - void Clear()
  5141. - bool Defined() const
  5142. - Intersection IsInside(const Vector3& point) const
  5143. - Intersection IsInside(const Sphere& sphere) const
  5144. - Intersection IsInsideFast(const Sphere& sphere) const
  5145. - Intersection IsInside(const BoundingBox& box) const
  5146. - Intersection IsInsideFast(const BoundingBox& box) const
  5147. - float Distance(const Vector3& point) const
  5148. Properties:
  5149. - Vector3 center
  5150. - float radius
  5151. <a name="Class_Spline"></a>
  5152. ### Spline
  5153. Methods:
  5154. - Spline() (GC)
  5155. - Spline* new()
  5156. - Spline(InterpolationMode mode) (GC)
  5157. - Spline* new(InterpolationMode mode)
  5158. - Spline(const Spline& rhs) (GC)
  5159. - Spline* new(const Spline& rhs)
  5160. - void delete()
  5161. - bool operator==(const Spline& rhs) const
  5162. - Variant GetPoint(float f) const
  5163. - Variant GetKnot(unsigned index) const
  5164. - void SetKnot(const Variant& knot, unsigned tolua_var_1)
  5165. - void AddKnot(const Variant& knot)
  5166. - void AddKnot(const Variant& knot, unsigned index)
  5167. - void RemoveKnot()
  5168. - void RemoveKnot(unsigned index)
  5169. - void Clear()
  5170. Properties:
  5171. - InterpolationMode interpolationMode
  5172. <a name="Class_SplinePath"></a>
  5173. ### SplinePath : Component
  5174. Methods:
  5175. - void AddControlPoint(Node* point, unsigned index = M_MAX_UNSIGNED)
  5176. - void RemoveControlPoint(Node* point)
  5177. - void ClearControlPoints()
  5178. - void SetInterpolationMode(InterpolationMode mode)
  5179. - void SetPosition(float factor)
  5180. - void SetControlledNode(Node* controlled)
  5181. - InterpolationMode GetInterpolationMode() const
  5182. - float GetSpeed() const
  5183. - float GetLength() const
  5184. - Vector3 GetPosition() const
  5185. - Node* GetControlledNode() const
  5186. - Vector3 GetPoint(float factor) const
  5187. - void Move(float timeStep)
  5188. - void Reset()
  5189. - bool IsFinished() const
  5190. Properties:
  5191. - InterpolationMode interpolationMode
  5192. - float speed
  5193. - float length (readonly)
  5194. - Node* controlledNode
  5195. <a name="Class_Sprite"></a>
  5196. ### Sprite : UIElement
  5197. Methods:
  5198. - Sprite() (GC)
  5199. - Sprite* new()
  5200. - void delete()
  5201. - void SetPosition(const Vector2& position)
  5202. - void SetPosition(float x, float y)
  5203. - void SetHotSpot(const IntVector2& hotSpot)
  5204. - void SetHotSpot(int x, int y)
  5205. - void SetScale(const Vector2& scale)
  5206. - void SetScale(float x, float y)
  5207. - void SetScale(float scale)
  5208. - void SetRotation(float angle)
  5209. - void SetTexture(Texture* texture)
  5210. - void SetImageRect(const IntRect& rect)
  5211. - void SetFullImageRect()
  5212. - void SetBlendMode(BlendMode mode)
  5213. - const Vector2& GetPosition() const
  5214. - const IntVector2& GetHotSpot() const
  5215. - const Vector2& GetScale() const
  5216. - float GetRotation() const
  5217. - Texture* GetTexture() const
  5218. - const IntRect& GetImageRect() const
  5219. - BlendMode GetBlendMode() const
  5220. - const Matrix3x4& GetTransform() const
  5221. Properties:
  5222. - Vector2& position
  5223. - IntVector2& hotSpot
  5224. - Vector2& scale
  5225. - float rotation
  5226. - Texture* texture
  5227. - IntRect& imageRect
  5228. - BlendMode blendMode
  5229. - Matrix3x4& transform (readonly)
  5230. <a name="Class_Sprite2D"></a>
  5231. ### Sprite2D : Resource
  5232. Methods:
  5233. - void SetTexture(Texture2D* texture)
  5234. - void SetRectangle(const IntRect& rectangle)
  5235. - void SetHotSpot(const Vector2& hotSpot)
  5236. - void SetOffset(const IntVector2& offset)
  5237. - void SetTextureEdgeOffset(float offset)
  5238. - void SetSpriteSheet(SpriteSheet2D* spriteSheet)
  5239. - Texture2D* GetTexture() const
  5240. - const IntRect& GetRectangle() const
  5241. - const Vector2& GetHotSpot() const
  5242. - const IntVector2& GetOffset() const
  5243. - float GetTextureEdgeOffset() const
  5244. - SpriteSheet2D* GetSpriteSheet() const
  5245. Properties:
  5246. - Texture2D* texture
  5247. - IntRect rectangle
  5248. - Vector2 hotSpot
  5249. - IntVector2 offset
  5250. - float textureEdgeOffset
  5251. - SpriteSheet2D* spriteSheet
  5252. <a name="Class_SpriteSheet2D"></a>
  5253. ### SpriteSheet2D : Resource
  5254. Methods:
  5255. - void SetTexture(Texture2D* texture)
  5256. - Texture2D* GetTexture() const
  5257. - Sprite2D* GetSprite(const String name) const
  5258. - void DefineSprite(const String name, const IntRect& rectangle)
  5259. - void DefineSprite(const String name, const IntRect& rectangle, const Vector2& hotSpot)
  5260. - void DefineSprite(const String name, const IntRect& rectangle, const Vector2& hotSpot, const IntVector2& originSize)
  5261. Properties:
  5262. - Texture2D* texture
  5263. <a name="Class_StaticModel"></a>
  5264. ### StaticModel : Drawable
  5265. Methods:
  5266. - void SetModel(Model* model)
  5267. - void SetMaterial(Material* material)
  5268. - bool SetMaterial(unsigned index, Material* material)
  5269. - void SetOcclusionLodLevel(unsigned level)
  5270. - void ApplyMaterialList(const String fileName = String::EMPTY)
  5271. - Model* GetModel() const
  5272. - unsigned GetNumGeometries() const
  5273. - Material* GetMaterial(unsigned index = 0) const
  5274. - unsigned GetOcclusionLodLevel() const
  5275. - bool IsInside(const Vector3& point) const
  5276. - bool IsInsideLocal(const Vector3& point) const
  5277. Properties:
  5278. - Model* model
  5279. - Material* material
  5280. - BoundingBox& boundingBox (readonly)
  5281. - unsigned numGeometries (readonly)
  5282. - unsigned occlusionLodLevel
  5283. <a name="Class_StaticModelGroup"></a>
  5284. ### StaticModelGroup : StaticModel
  5285. Methods:
  5286. - void AddInstanceNode(Node* node)
  5287. - void RemoveInstanceNode(Node* node)
  5288. - void RemoveAllInstanceNodes()
  5289. - unsigned GetNumInstanceNodes() const
  5290. - Node* GetInstanceNode(unsigned index) const
  5291. Properties:
  5292. - unsigned numInstanceNodes (readonly)
  5293. <a name="Class_StaticSprite2D"></a>
  5294. ### StaticSprite2D : Drawable2D
  5295. Methods:
  5296. - void SetSprite(Sprite2D* sprite)
  5297. - void SetBlendMode(BlendMode mode)
  5298. - void SetFlip(bool flipX, bool flipY)
  5299. - void SetFlipX(bool flipX)
  5300. - void SetFlipY(bool flipY)
  5301. - void SetColor(const Color& color)
  5302. - void SetAlpha(float alpha)
  5303. - void SetUseHotSpot(bool useHotSpot)
  5304. - void SetHotSpot(const Vector2& hotspot)
  5305. - void SetUseDrawRect(bool useDrawRect)
  5306. - void SetDrawRect(const Rect& rect)
  5307. - void SetUseTextureRect(bool useTextureRect)
  5308. - void SetTextureRect(const Rect& rect)
  5309. - void SetCustomMaterial(Material* customMaterial)
  5310. - Sprite2D* GetSprite() const
  5311. - BlendMode GetBlendMode() const
  5312. - bool GetFlipX() const
  5313. - bool GetFlipY() const
  5314. - const Color& GetColor() const
  5315. - float GetAlpha() const
  5316. - bool GetUseHotSpot() const
  5317. - const Vector2& GetHotSpot() const
  5318. - bool GetUseDrawRect() const
  5319. - const Rect& GetDrawRect() const
  5320. - bool GetUseTextureRect() const
  5321. - const Rect& GetTextureRect() const
  5322. - Material* GetCustomMaterial() const
  5323. Properties:
  5324. - Sprite2D* sprite
  5325. - BlendMode blendMode
  5326. - bool flipX
  5327. - bool flipY
  5328. - Color& color
  5329. - float alpha
  5330. - bool useHotSpot
  5331. - Vector2 hotSpot
  5332. - Material* customMaterial
  5333. - Rect drawRect
  5334. - bool useDrawRect
  5335. - Rect textureRect
  5336. - bool useTextureRect
  5337. <a name="Class_StringHash"></a>
  5338. ### StringHash
  5339. Methods:
  5340. - StringHash() (GC)
  5341. - StringHash* new()
  5342. - StringHash(const StringHash& rhs) (GC)
  5343. - StringHash* new(const StringHash& rhs)
  5344. - StringHash(const char* str) (GC)
  5345. - StringHash* new(const char* str)
  5346. - StringHash(unsigned value) (GC)
  5347. - StringHash* new(unsigned value)
  5348. - void delete()
  5349. - StringHash operator+(const StringHash& rhs) const
  5350. - bool operator==(const StringHash& rhs) const
  5351. - bool operator<(const StringHash& rhs) const
  5352. - bool operatorbool() const
  5353. - unsigned Value() const
  5354. - String ToString() const
  5355. - unsigned ToHash() const
  5356. - unsigned Calculate(const char* str)
  5357. Properties:
  5358. - const StringHash ZERO
  5359. - unsigned value (readonly)
  5360. <a name="Class_Technique"></a>
  5361. ### Technique : Resource
  5362. Methods:
  5363. - void SetIsDesktop(bool enable)
  5364. - Pass* CreatePass(const String passName)
  5365. - void RemovePass(const String passName)
  5366. - void ReleaseShaders()
  5367. - Technique* Clone(const String cloneName = String::EMPTY) const
  5368. - bool HasPass(const String type) const
  5369. - Pass* GetPass(const String type) const
  5370. - Pass* GetSupportedPass(const String type) const
  5371. - bool IsSupported() const
  5372. - bool IsDesktop() const
  5373. - unsigned GetNumPasses() const
  5374. - const Vector<String>& GetPassTypes() const
  5375. - const PODVector<Pass*>& GetPasses() const
  5376. Properties:
  5377. - bool supported (readonly)
  5378. - bool desktop (readonly)
  5379. - unsigned numPasses (readonly)
  5380. <a name="Class_Terrain"></a>
  5381. ### Terrain : Component
  5382. Methods:
  5383. - void SetPatchSize(int size)
  5384. - void SetSpacing(const Vector3& spacing)
  5385. - void SetMaxLodLevels(unsigned levels)
  5386. - void SetOcclusionLodLevel(unsigned level)
  5387. - void SetSmoothing(bool enable)
  5388. - bool SetHeightMap(Image* image)
  5389. - void SetMaterial(Material* material)
  5390. - void SetNorthNeighbor(Terrain* north)
  5391. - void SetSouthNeighbor(Terrain* south)
  5392. - void SetWestNeighbor(Terrain* west)
  5393. - void SetEastNeighbor(Terrain* east)
  5394. - void SetNeighbors(Terrain* north, Terrain* south, Terrain* west, Terrain* east)
  5395. - void SetDrawDistance(float distance)
  5396. - void SetShadowDistance(float distance)
  5397. - void SetLodBias(float bias)
  5398. - void SetViewMask(unsigned mask)
  5399. - void SetLightMask(unsigned mask)
  5400. - void SetShadowMask(unsigned mask)
  5401. - void SetZoneMask(unsigned mask)
  5402. - void SetMaxLights(unsigned num)
  5403. - void SetCastShadows(bool enable)
  5404. - void SetOccluder(bool enable)
  5405. - void SetOccludee(bool enable)
  5406. - void ApplyHeightMap()
  5407. - int GetPatchSize() const
  5408. - const Vector3& GetSpacing() const
  5409. - const IntVector2& GetNumVertices() const
  5410. - const IntVector2& GetNumPatches() const
  5411. - unsigned GetMaxLodLevels() const
  5412. - unsigned GetOcclusionLodLevel() const
  5413. - bool GetSmoothing() const
  5414. - Image* GetHeightMap() const
  5415. - Material* GetMaterial() const
  5416. - Terrain* GetNorthNeighbor() const
  5417. - Terrain* GetSouthNeighbor() const
  5418. - Terrain* GetWestNeighbor() const
  5419. - Terrain* GetEastNeighbor() const
  5420. - TerrainPatch* GetPatch(unsigned index) const
  5421. - TerrainPatch* GetPatch(int x, int z) const
  5422. - TerrainPatch* GetNeighborPatch(int x, int z) const
  5423. - float GetHeight(const Vector3& worldPosition) const
  5424. - Vector3 GetNormal(const Vector3& worldPosition) const
  5425. - IntVector2 WorldToHeightMap(const Vector3& worldPosition) const
  5426. - SharedArrayPtr<float> GetHeightData() const
  5427. - float GetDrawDistance() const
  5428. - float GetShadowDistance() const
  5429. - float GetLodBias() const
  5430. - unsigned GetViewMask() const
  5431. - unsigned GetLightMask() const
  5432. - unsigned GetShadowMask() const
  5433. - unsigned GetZoneMask() const
  5434. - unsigned GetMaxLights() const
  5435. - bool IsVisible() const
  5436. - bool GetCastShadows() const
  5437. - bool IsOccluder() const
  5438. - bool IsOccludee() const
  5439. Properties:
  5440. - int patchSize
  5441. - Vector3& spacing
  5442. - IntVector2& numVertices (readonly)
  5443. - IntVector2& numPatches (readonly)
  5444. - unsigned maxLodLevels
  5445. - unsigned occlusionLodLevel
  5446. - bool smoothing
  5447. - Image* heightMap
  5448. - Material* material
  5449. - Terrain* northNeighbor
  5450. - Terrain* southNeighbor
  5451. - Terrain* westNeighbor
  5452. - Terrain* eastNeighbor
  5453. - float drawDistance
  5454. - float shadowDistance
  5455. - float lodBias
  5456. - unsigned viewMask
  5457. - unsigned lightMask
  5458. - unsigned shadowMask
  5459. - unsigned zoneMask
  5460. - unsigned maxLights
  5461. - bool visible (readonly)
  5462. - bool castShadows
  5463. - bool occluder
  5464. - bool occludee
  5465. <a name="Class_TerrainPatch"></a>
  5466. ### TerrainPatch : Drawable
  5467. Methods:
  5468. - void SetOwner(Terrain* terrain)
  5469. - void SetNeighbors(TerrainPatch* north, TerrainPatch* south, TerrainPatch* west, TerrainPatch* east)
  5470. - void SetMaterial(Material* material)
  5471. - void SetBoundingBox(const BoundingBox& box)
  5472. - void SetCoordinates(const IntVector2& coordinates)
  5473. - void ResetLod()
  5474. - Geometry* GetGeometry() const
  5475. - Geometry* GetMaxLodGeometry() const
  5476. - Geometry* GetOcclusionGeometry() const
  5477. - VertexBuffer* GetVertexBuffer() const
  5478. - Terrain* GetOwner() const
  5479. - TerrainPatch* GetNorthPatch() const
  5480. - TerrainPatch* GetSouthPatch() const
  5481. - TerrainPatch* GetWestPatch() const
  5482. - TerrainPatch* GetEastPatch() const
  5483. - const IntVector2& GetCoordinates() const
  5484. - unsigned GetLodLevel() const
  5485. Properties:
  5486. - Geometry* geometry (readonly)
  5487. - Geometry* maxLodGeometry (readonly)
  5488. - Geometry* occlusionGeometry (readonly)
  5489. - VertexBuffer* vertexBuffer (readonly)
  5490. - Terrain* owner
  5491. - TerrainPatch* northPatch (readonly)
  5492. - TerrainPatch* southPatch (readonly)
  5493. - TerrainPatch* westPatch (readonly)
  5494. - TerrainPatch* eastPatch (readonly)
  5495. - BoundingBox& boundingBox
  5496. - IntVector2& coordinates
  5497. - unsigned lodLevel (readonly)
  5498. <a name="Class_Text"></a>
  5499. ### Text : UIElement
  5500. Methods:
  5501. - Text() (GC)
  5502. - Text* new()
  5503. - void delete()
  5504. - bool SetFont(const String fontName, int size = DEFAULT_FONT_SIZE)
  5505. - bool SetFont(Font* font, int size = DEFAULT_FONT_SIZE)
  5506. - bool SetFontSize(int size)
  5507. - void SetText(const String text)
  5508. - void SetTextAlignment(HorizontalAlignment align)
  5509. - void SetRowSpacing(float spacing)
  5510. - void SetWordwrap(bool enable)
  5511. - void SetSelection(unsigned start, unsigned length = M_MAX_UNSIGNED)
  5512. - void ClearSelection()
  5513. - void SetSelectionColor(const Color& color)
  5514. - void SetHoverColor(const Color& color)
  5515. - void SetTextEffect(TextEffect textEffect)
  5516. - void SetEffectShadowOffset(const IntVector2& offset)
  5517. - void SetEffectStrokeThickness(int thickness)
  5518. - void SetEffectRoundStroke(bool roundStroke)
  5519. - void SetEffectColor(const Color& effectColor)
  5520. - bool GetAutoLocalizable() const
  5521. - void SetAutoLocalizable(bool enable)
  5522. - Font* GetFont() const
  5523. - int GetFontSize() const
  5524. - const String GetText() const
  5525. - HorizontalAlignment GetTextAlignment() const
  5526. - float GetRowSpacing() const
  5527. - bool GetWordwrap() const
  5528. - unsigned GetSelectionStart() const
  5529. - unsigned GetSelectionLength() const
  5530. - const Color& GetSelectionColor() const
  5531. - const Color& GetHoverColor() const
  5532. - TextEffect GetTextEffect() const
  5533. - const IntVector2& GetEffectShadowOffset() const
  5534. - int GetEffectStrokeThickness() const
  5535. - bool GetEffectRoundStroke() const
  5536. - const Color& GetEffectColor() const
  5537. - int GetRowHeight() const
  5538. - unsigned GetNumRows() const
  5539. - unsigned GetNumChars() const
  5540. - int GetRowWidth(unsigned index) const
  5541. - IntVector2 GetCharPosition(unsigned index)
  5542. - IntVector2 GetCharSize(unsigned index)
  5543. - void SetEffectDepthBias(float bias)
  5544. - float GetEffectDepthBias() const
  5545. Properties:
  5546. - Font* font
  5547. - int fontSize
  5548. - String text
  5549. - HorizontalAlignment textAlignment
  5550. - float rowSpacing
  5551. - bool wordwrap
  5552. - bool autoLocalizable
  5553. - unsigned selectionStart (readonly)
  5554. - unsigned selectionLength (readonly)
  5555. - Color& selectionColor
  5556. - Color& hoverColor
  5557. - TextEffect textEffect
  5558. - IntVector2& effectShadowOffset
  5559. - int effectStrokeThickness
  5560. - bool effectRoundStroke
  5561. - Color& effectColor
  5562. - int rowHeight (readonly)
  5563. - unsigned numRows (readonly)
  5564. - unsigned numChars (readonly)
  5565. <a name="Class_Text3D"></a>
  5566. ### Text3D : Drawable
  5567. Methods:
  5568. - Text3D() (GC)
  5569. - Text3D* new()
  5570. - void delete()
  5571. - bool SetFont(const String fontName, int size = DEFAULT_FONT_SIZE)
  5572. - bool SetFont(Font* font, int size = DEFAULT_FONT_SIZE)
  5573. - bool SetFontSize(int size)
  5574. - void SetMaterial(Material* material)
  5575. - void SetText(const String text)
  5576. - void SetAlignment(HorizontalAlignment hAlign, VerticalAlignment vAlign)
  5577. - void SetHorizontalAlignment(HorizontalAlignment align)
  5578. - void SetVerticalAlignment(VerticalAlignment align)
  5579. - void SetTextAlignment(HorizontalAlignment align)
  5580. - void SetRowSpacing(float spacing)
  5581. - void SetWordwrap(bool enable)
  5582. - void SetTextEffect(TextEffect textEffect)
  5583. - void SetEffectShadowOffset(const IntVector2& offset)
  5584. - void SetEffectStrokeThickness(int thickness)
  5585. - void SetEffectRoundStroke(bool roundStroke)
  5586. - void SetEffectColor(const Color& effectColor)
  5587. - void SetEffectDepthBias(float bias)
  5588. - void SetWidth(int width)
  5589. - void SetColor(const Color& color)
  5590. - void SetColor(Corner corner, const Color& color)
  5591. - void SetOpacity(float opacity)
  5592. - void SetFixedScreenSize(bool enable)
  5593. - void SetFaceCameraMode(FaceCameraMode mode)
  5594. - Font* GetFont() const
  5595. - Material* GetMaterial() const
  5596. - int GetFontSize() const
  5597. - const String GetText() const
  5598. - HorizontalAlignment GetTextAlignment() const
  5599. - HorizontalAlignment GetHorizontalAlignment() const
  5600. - VerticalAlignment GetVerticalAlignment() const
  5601. - float GetRowSpacing() const
  5602. - bool GetWordwrap() const
  5603. - TextEffect GetTextEffect() const
  5604. - const IntVector2& GetEffectShadowOffset() const
  5605. - int GetEffectStrokeThickness() const
  5606. - bool GetEffectRoundStroke() const
  5607. - const Color& GetEffectColor() const
  5608. - float GetEffectDepthBias() const
  5609. - int GetWidth() const
  5610. - int GetHeight() const
  5611. - int GetRowHeight() const
  5612. - unsigned GetNumRows() const
  5613. - unsigned GetNumChars() const
  5614. - int GetRowWidth(unsigned index) const
  5615. - IntVector2 GetCharPosition(unsigned index)
  5616. - IntVector2 GetCharSize(unsigned index)
  5617. - const Color& GetColor(Corner corner) const
  5618. - float GetOpacity() const
  5619. - bool IsFixedScreenSize() const
  5620. - FaceCameraMode GetFaceCameraMode() const
  5621. Properties:
  5622. - Font* font
  5623. - Material* material
  5624. - int fontSize
  5625. - String text
  5626. - HorizontalAlignment textAlignment
  5627. - HorizontalAlignment horizontalAlignment
  5628. - VerticalAlignment verticalAlignment
  5629. - float rowSpacing
  5630. - bool wordwrap
  5631. - TextEffect textEffect
  5632. - IntVector2& effectShadowOffset
  5633. - int effectStrokeThickness
  5634. - bool effectRoundStroke
  5635. - Color& effectColor
  5636. - float effectDepthBias
  5637. - int width
  5638. - Color& color
  5639. - int height (readonly)
  5640. - int rowHeight (readonly)
  5641. - unsigned numRows (readonly)
  5642. - unsigned numChars (readonly)
  5643. - float opacity
  5644. - bool fixedScreenSize
  5645. - FaceCameraMode faceCameraMode
  5646. <a name="Class_Texture"></a>
  5647. ### Texture : Resource
  5648. Methods:
  5649. - void SetNumLevels(unsigned levels)
  5650. - void SetFilterMode(TextureFilterMode filter)
  5651. - void SetAddressMode(TextureCoordinate coord, TextureAddressMode address)
  5652. - void SetAnisotropy(unsigned level)
  5653. - void SetBorderColor(const Color& color)
  5654. - void SetSRGB(bool enable)
  5655. - void SetBackupTexture(Texture* texture)
  5656. - void SetMipsToSkip(int quality, int toSkip)
  5657. - unsigned GetFormat() const
  5658. - bool IsCompressed() const
  5659. - unsigned GetLevels() const
  5660. - int GetWidth() const
  5661. - int GetHeight() const
  5662. - TextureFilterMode GetFilterMode() const
  5663. - TextureAddressMode GetAddressMode(TextureCoordinate coord) const
  5664. - unsigned GetAnisotropy() const
  5665. - const Color& GetBorderColor() const
  5666. - bool GetSRGB() const
  5667. - int GetMultiSample() const
  5668. - bool GetAutoResolve() const
  5669. - bool IsResolveDirty() const
  5670. - bool GetLevelsDirty() const
  5671. - Texture* GetBackupTexture() const
  5672. - int GetMipsToSkip(int quality) const
  5673. - int GetLevelWidth(unsigned level) const
  5674. - int GetLevelHeight(unsigned level) const
  5675. - TextureUsage GetUsage() const
  5676. - unsigned GetDataSize(int width, int height) const
  5677. - unsigned GetRowDataSize(int width) const
  5678. - unsigned GetComponents() const
  5679. Properties:
  5680. - unsigned format (readonly)
  5681. - bool compressed (readonly)
  5682. - unsigned levels (readonly)
  5683. - int width (readonly)
  5684. - int height (readonly)
  5685. - unsigned components (readonly)
  5686. - TextureFilterMode filterMode
  5687. - unsigned anisotropy
  5688. - Color& borderColor
  5689. - bool sRGB
  5690. - int multiSample (readonly)
  5691. - bool autoResolve (readonly)
  5692. - bool resolveDirty (readonly)
  5693. - bool levelsDirty (readonly)
  5694. - Texture* backupTexture
  5695. - TextureUsage usage (readonly)
  5696. <a name="Class_Texture2D"></a>
  5697. ### Texture2D : Texture
  5698. Methods:
  5699. - Texture2D() (GC)
  5700. - Texture2D* new()
  5701. - void delete()
  5702. - bool SetSize(int width, int height, unsigned format, TextureUsage usage = TEXTURE_STATIC, int multiSample = 1, bool autoResolve = true)
  5703. - bool SetData(Image* image, bool useAlpha = false)
  5704. - Image* GetImage() const
  5705. - RenderSurface* GetRenderSurface() const
  5706. Properties:
  5707. - RenderSurface* renderSurface (readonly)
  5708. <a name="Class_Texture2DArray"></a>
  5709. ### Texture2DArray : Texture
  5710. Methods:
  5711. - Texture2DArray() (GC)
  5712. - Texture2DArray* new()
  5713. - void delete()
  5714. - void SetLayers(unsigned layers)
  5715. - bool SetSize(unsigned layers, int width, int height, unsigned format, TextureUsage usage = TEXTURE_STATIC)
  5716. - bool SetData(unsigned layer, Image* image, bool useAlpha = false)
  5717. - unsigned GetLayers() const
  5718. - RenderSurface* GetRenderSurface() const
  5719. Properties:
  5720. - unsigned layers
  5721. - RenderSurface* renderSurface (readonly)
  5722. <a name="Class_Texture3D"></a>
  5723. ### Texture3D : Texture
  5724. Methods:
  5725. - Texture3D() (GC)
  5726. - Texture3D* new()
  5727. - void delete()
  5728. - bool SetSize(int width, int height, int depth, unsigned format, TextureUsage usage = TEXTURE_STATIC)
  5729. - bool SetData(Image* image, bool useAlpha = false)
  5730. <a name="Class_TextureCube"></a>
  5731. ### TextureCube : Texture
  5732. Methods:
  5733. - TextureCube() (GC)
  5734. - TextureCube* new()
  5735. - void delete()
  5736. - bool SetSize(int size, unsigned format, TextureUsage usage = TEXTURE_STATIC, int multiSample = 1)
  5737. - bool SetData(CubeMapFace face, Image* image, bool useAlpha = false)
  5738. - Image* GetImage(CubeMapFace face) const
  5739. - RenderSurface* GetRenderSurface(CubeMapFace face) const
  5740. <a name="Class_TextureFrame"></a>
  5741. ### TextureFrame
  5742. Methods:
  5743. - TextureFrame() (GC)
  5744. - TextureFrame* new()
  5745. - void delete()
  5746. Properties:
  5747. - Rect uv
  5748. - float time
  5749. <a name="Class_Tile2D"></a>
  5750. ### Tile2D
  5751. Methods:
  5752. - int GetGid() const
  5753. - Sprite2D* GetSprite() const
  5754. - bool HasProperty(const String name) const
  5755. - const String GetProperty(const String name) const
  5756. Properties:
  5757. - int gid (readonly)
  5758. - Sprite2D* sprite (readonly)
  5759. <a name="Class_TileMap2D"></a>
  5760. ### TileMap2D : Component
  5761. Methods:
  5762. - void SetTmxFile(TmxFile2D* tmxFile)
  5763. - TmxFile2D* GetTmxFile() const
  5764. - const TileMapInfo2D& GetInfo() const
  5765. - unsigned GetNumLayers() const
  5766. - TileMapLayer2D* GetLayer(unsigned index) const
  5767. - Vector2 TileIndexToPosition(int x, int y) const
  5768. - bool PositionToTileIndex(const Vector2& position, int x = 0, int y = 0) const
  5769. Properties:
  5770. - TmxFile2D* tmxFile
  5771. - TileMapInfo2D& info (readonly)
  5772. - unsigned numLayers (readonly)
  5773. <a name="Class_TileMapInfo2D"></a>
  5774. ### TileMapInfo2D
  5775. Methods:
  5776. - float GetMapWidth() const
  5777. - float GetMapHeight() const
  5778. Properties:
  5779. - Orientation2D orientation
  5780. - int width
  5781. - int height
  5782. - float tileWidth
  5783. - float tileHeight
  5784. - float mapWidth (readonly)
  5785. - float mapHeight (readonly)
  5786. <a name="Class_TileMapLayer2D"></a>
  5787. ### TileMapLayer2D : Component
  5788. Methods:
  5789. - void SetDrawOrder(int drawOrder)
  5790. - void SetVisible(bool visible)
  5791. - int GetDrawOrder() const
  5792. - bool IsVisible() const
  5793. - bool HasProperty(const String name) const
  5794. - const String GetProperty(const String name) const
  5795. - TileMapLayerType2D GetLayerType() const
  5796. - int GetWidth() const
  5797. - int GetHeight() const
  5798. - Node* GetTileNode(int x, int y) const
  5799. - Tile2D* GetTile(int x, int y) const
  5800. - unsigned GetNumObjects() const
  5801. - TileMapObject2D* GetObject(unsigned index) const
  5802. - Node* GetObjectNode(unsigned index) const
  5803. - Node* GetImageNode() const
  5804. Properties:
  5805. - int drawOrder (readonly)
  5806. - bool visible (readonly)
  5807. - TileMapLayerType2D layerType (readonly)
  5808. - int width (readonly)
  5809. - int height (readonly)
  5810. - unsigned numObjects (readonly)
  5811. - Node* imageNode (readonly)
  5812. <a name="Class_TileMapObject2D"></a>
  5813. ### TileMapObject2D
  5814. Methods:
  5815. - TileMapObjectType2D GetObjectType() const
  5816. - const String GetName() const
  5817. - const String GetType() const
  5818. - const Vector2& GetPosition() const
  5819. - const Vector2& GetSize() const
  5820. - unsigned GetNumPoints() const
  5821. - const Vector2& GetPoint(unsigned index) const
  5822. - int GetTileGid() const
  5823. - Sprite2D* GetTileSprite() const
  5824. - bool HasProperty(const String name) const
  5825. - const String GetProperty(const String name) const
  5826. Properties:
  5827. - TileMapObjectType2D objectType (readonly)
  5828. - String name (readonly)
  5829. - String type (readonly)
  5830. - Vector2 position (readonly)
  5831. - Vector2 size (readonly)
  5832. - unsigned numPoints (readonly)
  5833. - int tileGid (readonly)
  5834. - Sprite2D* tileSprite (readonly)
  5835. <a name="Class_Time"></a>
  5836. ### Time : Object
  5837. Methods:
  5838. - unsigned GetFrameNumber() const
  5839. - float GetTimeStep() const
  5840. - unsigned GetTimerPeriod() const
  5841. - float GetElapsedTime()
  5842. - unsigned GetSystemTime()
  5843. - unsigned GetTimeSinceEpoch()
  5844. - String GetTimeStamp()
  5845. - void Sleep(unsigned mSec)
  5846. Properties:
  5847. - unsigned frameNumber (readonly)
  5848. - float timeStep (readonly)
  5849. - unsigned timerPeriod (readonly)
  5850. - float elapsedTime (readonly)
  5851. <a name="Class_TmxFile2D"></a>
  5852. ### TmxFile2D : Resource
  5853. <a name="Class_ToolTip"></a>
  5854. ### ToolTip : UIElement
  5855. Methods:
  5856. - ToolTip() (GC)
  5857. - ToolTip* new()
  5858. - void delete()
  5859. - void SetDelay(float delay)
  5860. - float GetDelay() const
  5861. Properties:
  5862. - float delay
  5863. <a name="Class_TouchState"></a>
  5864. ### TouchState
  5865. Methods:
  5866. - UIElement* GetTouchedElement()
  5867. Properties:
  5868. - int touchID
  5869. - IntVector2 position
  5870. - IntVector2 lastPosition
  5871. - IntVector2 delta
  5872. - float pressure
  5873. - UIElement* touchedElement (readonly)
  5874. <a name="Class_UI"></a>
  5875. ### UI : Object
  5876. Methods:
  5877. - void SetCursor(Cursor* cursor)
  5878. - void SetFocusElement(UIElement* element, bool byKey = false)
  5879. - bool SetModalElement(UIElement* modalElement, bool enable)
  5880. - void Clear()
  5881. - void DebugDraw(UIElement* element)
  5882. - UIElement* LoadLayout(File* source, XMLFile* styleFile = 0)
  5883. - UIElement* LoadLayout(const String fileName, XMLFile* styleFile = 0)
  5884. - UIElement* LoadLayout(XMLFile* file, XMLFile* styleFile = 0)
  5885. - bool SaveLayout(Serializer& dest, UIElement* element)
  5886. - void SetClipboardText(const String text)
  5887. - void SetDoubleClickInterval(float interval)
  5888. - void SetDragBeginInterval(float interval)
  5889. - void SetDragBeginDistance(int pixels)
  5890. - void SetDefaultToolTipDelay(float delay)
  5891. - void SetMaxFontTextureSize(int size)
  5892. - void SetNonFocusedMouseWheel(bool nonFocusedMouseWheel)
  5893. - void SetUseSystemClipboard(bool enable)
  5894. - void SetUseScreenKeyboard(bool enable)
  5895. - void SetUseMutableGlyphs(bool enable)
  5896. - void SetForceAutoHint(bool enable)
  5897. - void SetScale(float scale)
  5898. - void SetWidth(float width)
  5899. - void SetHeight(float height)
  5900. - void SetCustomSize(const IntVector2& size)
  5901. - void SetCustomSize(int width, int height)
  5902. - UIElement* GetRoot() const
  5903. - UIElement* GetRootModalElement() const
  5904. - Cursor* GetCursor() const
  5905. - IntVector2 GetCursorPosition() const
  5906. - UIElement* GetElementAt(const IntVector2& position, bool enabledOnly = true)
  5907. - UIElement* GetElementAt(int x, int y, bool enabledOnly = true)
  5908. - UIElement* GetFocusElement() const
  5909. - UIElement* GetFrontElement() const
  5910. - UIElement* GetDragElement(unsigned index)
  5911. - const String GetClipboardText() const
  5912. - float GetDoubleClickInterval() const
  5913. - float GetDragBeginInterval() const
  5914. - int GetDragBeginDistance() const
  5915. - float GetDefaultToolTipDelay() const
  5916. - int GetMaxFontTextureSize() const
  5917. - bool IsNonFocusedMouseWheel() const
  5918. - bool GetUseSystemClipboard() const
  5919. - bool GetUseScreenKeyboard() const
  5920. - bool GetUseMutableGlyphs() const
  5921. - bool GetForceAutoHint() const
  5922. - bool HasModalElement() const
  5923. - bool IsDragging() const
  5924. - float GetScale() const
  5925. - const IntVector2& GetCustomSize() const
  5926. Properties:
  5927. - UIElement* root (readonly)
  5928. - UIElement* rootModalElement (readonly)
  5929. - Cursor* cursor
  5930. - IntVector2 cursorPosition (readonly)
  5931. - UIElement* focusElement (readonly)
  5932. - UIElement* frontElement (readonly)
  5933. - String clipboardText
  5934. - float doubleClickInterval
  5935. - float dragBeginInterval
  5936. - int dragBeginDistance
  5937. - float defaultToolTipDelay
  5938. - int maxFontTextureSize
  5939. - bool nonFocusedMouseWheel
  5940. - bool useSystemClipboard
  5941. - bool useScreenKeyboard
  5942. - bool useMutableGlyphs
  5943. - bool forceAutoHint
  5944. - bool modalElement (readonly)
  5945. - float scale
  5946. - IntVector2& customSize
  5947. <a name="Class_UIElement"></a>
  5948. ### UIElement : Animatable
  5949. Methods:
  5950. - UIElement() (GC)
  5951. - UIElement* new()
  5952. - void delete()
  5953. - const IntVector2& GetScreenPosition() const
  5954. - bool LoadXML(Deserializer& source)
  5955. - bool SaveXML(Serializer& dest, const String indentation = "\t") const
  5956. - bool LoadXML(const String fileName)
  5957. - bool SaveXML(const String fileName, const String indentation = "\t") const
  5958. - bool FilterAttributes(XMLElement& dest) const
  5959. - void SetName(const String name)
  5960. - void SetPosition(const IntVector2& position)
  5961. - void SetPosition(int x, int y)
  5962. - void SetSize(const IntVector2& size)
  5963. - void SetSize(int width, int height)
  5964. - void SetWidth(int width)
  5965. - void SetHeight(int height)
  5966. - void SetMinSize(const IntVector2& minSize)
  5967. - void SetMinSize(int width, int height)
  5968. - void SetMinWidth(int width)
  5969. - void SetMinHeight(int height)
  5970. - void SetMaxSize(const IntVector2& maxSize)
  5971. - void SetMaxSize(int width, int height)
  5972. - void SetMaxWidth(int width)
  5973. - void SetMaxHeight(int height)
  5974. - void SetFixedSize(const IntVector2& size)
  5975. - void SetFixedSize(int width, int height)
  5976. - void SetFixedWidth(int width)
  5977. - void SetFixedHeight(int height)
  5978. - void SetAlignment(HorizontalAlignment hAlign, VerticalAlignment vAlign)
  5979. - void SetHorizontalAlignment(HorizontalAlignment align)
  5980. - void SetVerticalAlignment(VerticalAlignment align)
  5981. - void SetEnableAnchor(bool enable)
  5982. - void SetMinAnchor(const Vector2& anchor)
  5983. - void SetMinAnchor(float x, float y)
  5984. - void SetMaxAnchor(const Vector2& anchor)
  5985. - void SetMaxAnchor(float x, float y)
  5986. - void SetMinOffset(const IntVector2& offset)
  5987. - void SetMaxOffset(const IntVector2& offset)
  5988. - void SetPivot(const Vector2& pivot)
  5989. - void SetPivot(float x, float y)
  5990. - void SetClipBorder(const IntRect& rect)
  5991. - void SetColor(const Color& color)
  5992. - void SetColor(Corner corner, const Color& color)
  5993. - void SetPriority(int priority)
  5994. - void SetOpacity(float opacity)
  5995. - void SetBringToFront(bool enable)
  5996. - void SetBringToBack(bool enable)
  5997. - void SetClipChildren(bool enable)
  5998. - void SetSortChildren(bool enable)
  5999. - void SetUseDerivedOpacity(bool enable)
  6000. - void SetEnabled(bool enable)
  6001. - void SetDeepEnabled(bool enable)
  6002. - void ResetDeepEnabled()
  6003. - void SetEnabledRecursive(bool enable)
  6004. - void SetEditable(bool enable)
  6005. - void SetFocus(bool enable)
  6006. - void SetSelected(bool enable)
  6007. - void SetVisible(bool enable)
  6008. - void SetFocusMode(FocusMode mode)
  6009. - void SetDragDropMode(unsigned mode)
  6010. - bool SetStyle(const String styleName, XMLFile* file = 0)
  6011. - bool SetStyle(const XMLElement& element)
  6012. - bool SetStyleAuto(XMLFile* file = 0)
  6013. - void SetDefaultStyle(XMLFile* style)
  6014. - void SetLayout(LayoutMode mode, int spacing = 0)
  6015. - void SetLayout(LayoutMode mode, int spacing, const IntRect& border)
  6016. - void SetLayoutMode(LayoutMode mode)
  6017. - void SetLayoutSpacing(int spacing)
  6018. - void SetLayoutBorder(const IntRect& border)
  6019. - void SetLayoutFlexScale(const Vector2& scale)
  6020. - void SetIndent(int indent)
  6021. - void SetIndentSpacing(int indentSpacing)
  6022. - void UpdateLayout()
  6023. - void DisableLayoutUpdate()
  6024. - void EnableLayoutUpdate()
  6025. - void BringToFront()
  6026. - UIElement* CreateChild(const String type, const String name = String::EMPTY, unsigned index = M_MAX_UNSIGNED)
  6027. - void AddChild(UIElement* element)
  6028. - void InsertChild(unsigned index, UIElement* element)
  6029. - void RemoveChild(UIElement* element, unsigned index = 0)
  6030. - void RemoveChildAtIndex(unsigned index)
  6031. - void RemoveAllChildren()
  6032. - void Remove()
  6033. - unsigned FindChild(UIElement* element) const
  6034. - void SetParent(UIElement* parent, unsigned index = M_MAX_UNSIGNED)
  6035. - void SetVar(StringHash key, const Variant& value)
  6036. - void SetInternal(bool enable)
  6037. - void SetTraversalMode(TraversalMode traversalMode)
  6038. - void SetElementEventSender(bool flag)
  6039. - void AddTag(const String tag)
  6040. - void AddTags(const String tags, char separator)
  6041. - bool RemoveTag(const String tag)
  6042. - void RemoveAllTags()
  6043. - const String GetName() const
  6044. - const IntVector2& GetPosition() const
  6045. - const IntVector2& GetSize() const
  6046. - int GetWidth() const
  6047. - int GetHeight() const
  6048. - const IntVector2& GetMinSize() const
  6049. - int GetMinWidth() const
  6050. - int GetMinHeight() const
  6051. - const IntVector2& GetMaxSize() const
  6052. - int GetMaxWidth() const
  6053. - int GetMaxHeight() const
  6054. - bool IsFixedSize() const
  6055. - bool IsFixedWidth() const
  6056. - bool IsFixedHeight() const
  6057. - const IntVector2& GetChildOffset() const
  6058. - HorizontalAlignment GetHorizontalAlignment() const
  6059. - VerticalAlignment GetVerticalAlignment() const
  6060. - bool GetEnableAnchor() const
  6061. - const Vector2& GetMinAnchor() const
  6062. - const Vector2& GetMaxAnchor() const
  6063. - const IntVector2& GetMinOffset() const
  6064. - const IntVector2& GetMaxOffset() const
  6065. - const Vector2& GetPivot() const
  6066. - const IntRect& GetClipBorder() const
  6067. - const Color& GetColor(Corner corner) const
  6068. - int GetPriority() const
  6069. - float GetOpacity() const
  6070. - float GetDerivedOpacity() const
  6071. - bool GetBringToFront() const
  6072. - bool GetBringToBack() const
  6073. - bool GetClipChildren() const
  6074. - bool GetSortChildren() const
  6075. - bool GetUseDerivedOpacity() const
  6076. - bool HasFocus() const
  6077. - bool IsEnabled() const
  6078. - bool IsEnabledSelf() const
  6079. - bool IsEditable() const
  6080. - bool IsSelected() const
  6081. - bool IsVisible() const
  6082. - bool IsVisibleEffective() const
  6083. - bool IsHovering() const
  6084. - bool IsInternal() const
  6085. - bool HasColorGradient() const
  6086. - FocusMode GetFocusMode() const
  6087. - unsigned GetDragDropMode() const
  6088. - const String GetAppliedStyle() const
  6089. - XMLFile* GetDefaultStyle(bool recursiveUp = true) const
  6090. - LayoutMode GetLayoutMode() const
  6091. - int GetLayoutSpacing() const
  6092. - const IntRect& GetLayoutBorder() const
  6093. - const Vector2& GetLayoutFlexScale() const
  6094. - unsigned GetNumChildren(bool recursive = false) const
  6095. - int GetDragButtonCombo() const
  6096. - unsigned GetDragButtonCount() const
  6097. - UIElement* GetChild(const String name, bool recursive = false) const
  6098. - UIElement* GetChild(unsigned index) const
  6099. - UIElement* GetParent() const
  6100. - UIElement* GetRoot() const
  6101. - const Color& GetDerivedColor() const
  6102. - const Variant& GetVar(StringHash key) const
  6103. - const VariantMap& GetVars() const
  6104. - bool HasTag(const String tag) const
  6105. - const StringVector& GetTags() const
  6106. - const PODVector<UIElement*>& GetChildrenWithTag(const String tag, bool recursive = false) const
  6107. - IntVector2 ScreenToElement(const IntVector2& screenPosition)
  6108. - IntVector2 ElementToScreen(const IntVector2& position)
  6109. - bool IsInside(IntVector2 position, bool isScreen)
  6110. - bool IsInsideCombined(IntVector2 position, bool isScreen)
  6111. - IntRect GetCombinedScreenRect()
  6112. - void SortChildren()
  6113. - int GetIndent() const
  6114. - int GetIndentSpacing() const
  6115. - int GetIndentWidth() const
  6116. - void SetChildOffset(const IntVector2& offset)
  6117. - void SetHovering(bool enable)
  6118. - const Color& GetColor() const
  6119. - TraversalMode GetTraversalMode() const
  6120. - bool IsElementEventSender() const
  6121. - UIElement* GetElementEventSender() const
  6122. Properties:
  6123. - IntVector2& screenPosition (readonly)
  6124. - String name
  6125. - IntVector2& position
  6126. - IntVector2 size
  6127. - int width
  6128. - int height
  6129. - IntVector2 minSize
  6130. - int minWidth
  6131. - int minHeight
  6132. - IntVector2 maxSize
  6133. - int maxWidth
  6134. - int maxHeight
  6135. - bool fixedSize (readonly)
  6136. - bool fixedWidth (readonly)
  6137. - bool fixedHeight (readonly)
  6138. - IntVector2& childOffset
  6139. - HorizontalAlignment horizontalAlignment
  6140. - VerticalAlignment verticalAlignment
  6141. - bool enableAnchor
  6142. - IntVector2& minOffset
  6143. - IntVector2& maxOffset
  6144. - Vector2& minAnchor
  6145. - Vector2& maxAnchor
  6146. - Vector2& pivot
  6147. - IntRect clipBorder
  6148. - Color& color
  6149. - int priority
  6150. - float opacity
  6151. - float derivedOpacity (readonly)
  6152. - bool bringToFront
  6153. - bool bringToBack
  6154. - bool clipChildren
  6155. - bool sortChildren
  6156. - bool useDerivedOpacity
  6157. - bool focus
  6158. - bool enabled
  6159. - bool enabledSelf (readonly)
  6160. - bool editable
  6161. - bool selected
  6162. - bool visible
  6163. - bool visibleEffective (readonly)
  6164. - bool hovering
  6165. - bool internal
  6166. - bool colorGradient (readonly)
  6167. - FocusMode focusMode
  6168. - unsigned dragDropMode
  6169. - String style
  6170. - XMLFile* defaultStyle
  6171. - LayoutMode layoutMode
  6172. - int layoutSpacing
  6173. - IntRect& layoutBorder
  6174. - Vector2& layoutFlexScale
  6175. - unsigned numChildren (readonly)
  6176. - UIElement* parent
  6177. - UIElement* root (readonly)
  6178. - Color& derivedColor (readonly)
  6179. - IntRect combinedScreenRect (readonly)
  6180. - int indent
  6181. - int indentSpacing
  6182. - int indentWidth (readonly)
  6183. - TraversalMode traversalMode
  6184. - bool elementEventSender
  6185. <a name="Class_ValueAnimation"></a>
  6186. ### ValueAnimation : Resource
  6187. Methods:
  6188. - ValueAnimation() (GC)
  6189. - ValueAnimation* new()
  6190. - void delete()
  6191. - void SetInterpolationMethod(InterpMethod method)
  6192. - void SetSplineTension(float tension)
  6193. - void SetValueType(VariantType valueType)
  6194. - bool SetKeyFrame(float time, const Variant& value)
  6195. - void SetEventFrame(float time, const StringHash& eventType)
  6196. - void SetEventFrame(float time, const StringHash& eventType, const VariantMap& eventData)
  6197. - InterpMethod GetInterpolationMethod() const
  6198. - float GetSplineTension() const
  6199. - VariantType GetValueType() const
  6200. Properties:
  6201. - InterpMethod interpolationMethod
  6202. - float splineTension
  6203. - VariantType valueType
  6204. <a name="Class_Variant"></a>
  6205. ### Variant
  6206. Methods:
  6207. - Variant() (GC)
  6208. - Variant* new()
  6209. - Variant(const Variant& value) (GC)
  6210. - Variant* new(const Variant& value)
  6211. - Variant(const char* type, const char* value) (GC)
  6212. - Variant* new(const char* type, const char* value)
  6213. - Variant(VariantType type, const char* value) (GC)
  6214. - Variant* new(VariantType type, const char* value)
  6215. - void delete()
  6216. - void Clear()
  6217. - bool operator==(const Variant& rhs) const
  6218. - void Set(const Variant& rhs)
  6219. - void* Get(const char* type = 0) const
  6220. - int GetInt() const
  6221. - unsigned GetUInt() const
  6222. - StringHash GetStringHash() const
  6223. - bool GetBool() const
  6224. - float GetFloat() const
  6225. - double GetDouble() const
  6226. - const Vector2& GetVector2() const
  6227. - const Vector3& GetVector3() const
  6228. - const Vector4& GetVector4() const
  6229. - const Quaternion& GetQuaternion() const
  6230. - const Color& GetColor() const
  6231. - const String GetString() const
  6232. - const PODVector<unsigned char>& GetRawBuffer() const
  6233. - VectorBuffer GetBuffer() const
  6234. - void* GetVoidPtr(const char* type) const
  6235. - const ResourceRef& GetResourceRef() const
  6236. - const ResourceRefList& GetResourceRefList() const
  6237. - const Vector<Variant>& GetVariantVector() const
  6238. - const VariantMap& GetVariantMap() const
  6239. - const Vector<String>& GetStringVector() const
  6240. - const Rect& GetRect() const
  6241. - const IntRect& GetIntRect() const
  6242. - const IntVector2& GetIntVector2() const
  6243. - const IntVector3& GetIntVector3() const
  6244. - RefCounted* GetPtr(const char* type) const
  6245. - const Matrix3& GetMatrix3() const
  6246. - const Matrix3x4& GetMatrix3x4() const
  6247. - const Matrix4& GetMatrix4() const
  6248. - VariantType GetType() const
  6249. - String GetTypeName() const
  6250. - String ToString() const
  6251. - bool IsZero() const
  6252. - bool IsEmpty() const
  6253. Properties:
  6254. - VariantType type (readonly)
  6255. - String typeName (readonly)
  6256. - bool zero (readonly)
  6257. - bool empty (readonly)
  6258. <a name="Class_VariantMap"></a>
  6259. ### VariantMap
  6260. Methods:
  6261. - VariantMap() (GC)
  6262. - VariantMap* new()
  6263. - void delete()
  6264. <a name="Class_Vector2"></a>
  6265. ### Vector2
  6266. Methods:
  6267. - Vector2() (GC)
  6268. - Vector2* new()
  6269. - Vector2(const Vector2& vector) (GC)
  6270. - Vector2* new(const Vector2& vector)
  6271. - Vector2(const IntVector2& vector) (GC)
  6272. - Vector2* new(const IntVector2& vector)
  6273. - Vector2(float x, float y) (GC)
  6274. - Vector2* new(float x, float y)
  6275. - void delete()
  6276. - bool operator==(const Vector2& rhs) const
  6277. - Vector2 operator+(const Vector2& rhs) const
  6278. - Vector2 operator-() const
  6279. - Vector2 operator-(const Vector2& rhs) const
  6280. - Vector2 operator*(float rhs) const
  6281. - Vector2 operator*(const Vector2& rhs) const
  6282. - Vector2 operator/(float rhs) const
  6283. - Vector2 operator/(const Vector2& rhs) const
  6284. - Vector2 operator/(const Vector2& rhs) const
  6285. - void Normalize()
  6286. - float Length() const
  6287. - float LengthSquared() const
  6288. - float DotProduct(const Vector2& rhs) const
  6289. - float AbsDotProduct(const Vector2& rhs) const
  6290. - float ProjectOntoAxis(const Vector2& axis) const
  6291. - float Angle(const Vector2& rhs) const
  6292. - Vector2 Abs() const
  6293. - Vector2 Lerp(const Vector2& rhs, float t) const
  6294. - bool Equals(const Vector2& rhs) const
  6295. - bool IsNaN() const
  6296. - Vector2 Normalized() const
  6297. - String ToString() const
  6298. Properties:
  6299. - float x
  6300. - float y
  6301. - const Vector2 ZERO
  6302. - const Vector2 LEFT
  6303. - const Vector2 RIGHT
  6304. - const Vector2 UP
  6305. - const Vector2 DOWN
  6306. - const Vector2 ONE
  6307. <a name="Class_Vector3"></a>
  6308. ### Vector3
  6309. Methods:
  6310. - Vector3() (GC)
  6311. - Vector3* new()
  6312. - Vector3(const Vector3& vector) (GC)
  6313. - Vector3* new(const Vector3& vector)
  6314. - Vector3(const Vector2& vector, float z) (GC)
  6315. - Vector3* new(const Vector2& vector, float z)
  6316. - Vector3(const Vector2& vector) (GC)
  6317. - Vector3* new(const Vector2& vector)
  6318. - Vector3(const IntVector3& vector) (GC)
  6319. - Vector3* new(const IntVector3& vector)
  6320. - Vector3(float x, float y, float z) (GC)
  6321. - Vector3* new(float x, float y, float z)
  6322. - Vector3(float x, float y) (GC)
  6323. - Vector3* new(float x, float y)
  6324. - void delete()
  6325. - bool operator==(const Vector3& rhs) const
  6326. - Vector3 operator+(const Vector3& rhs) const
  6327. - Vector3 operator-() const
  6328. - Vector3 operator-(const Vector3& rhs) const
  6329. - Vector3 operator*(float rhs) const
  6330. - Vector3 operator*(const Vector3& rhs) const
  6331. - Vector3 operator/(float rhs) const
  6332. - Vector3 operator/(const Vector3& rhs) const
  6333. - void Normalize()
  6334. - float Length() const
  6335. - float LengthSquared() const
  6336. - float DotProduct(const Vector3& rhs) const
  6337. - float AbsDotProduct(const Vector3& rhs) const
  6338. - float ProjectOntoAxis(const Vector3& axis) const
  6339. - Vector3 CrossProduct(const Vector3& rhs) const
  6340. - Vector3 Abs() const
  6341. - Vector3 Lerp(const Vector3& rhs, float t) const
  6342. - bool Equals(const Vector3& rhs) const
  6343. - bool IsNaN() const
  6344. - float Angle(const Vector3& rhs) const
  6345. - Vector3 Normalized() const
  6346. - String ToString() const
  6347. Properties:
  6348. - float x
  6349. - float y
  6350. - float z
  6351. - const Vector3 ZERO
  6352. - const Vector3 LEFT
  6353. - const Vector3 RIGHT
  6354. - const Vector3 UP
  6355. - const Vector3 DOWN
  6356. - const Vector3 FORWARD
  6357. - const Vector3 BACK
  6358. - const Vector3 ONE
  6359. <a name="Class_Vector4"></a>
  6360. ### Vector4
  6361. Methods:
  6362. - Vector4() (GC)
  6363. - Vector4* new()
  6364. - Vector4(const Vector4& vector) (GC)
  6365. - Vector4* new(const Vector4& vector)
  6366. - Vector4(const Vector3& vector, float w) (GC)
  6367. - Vector4* new(const Vector3& vector, float w)
  6368. - Vector4(float x, float y, float z, float w) (GC)
  6369. - Vector4* new(float x, float y, float z, float w)
  6370. - void delete()
  6371. - bool operator==(const Vector4& rhs) const
  6372. - Vector4 operator+(const Vector4& rhs) const
  6373. - Vector4 operator-() const
  6374. - Vector4 operator-(const Vector4& rhs) const
  6375. - Vector4 operator*(float rhs) const
  6376. - Vector4 operator*(const Vector4& rhs) const
  6377. - Vector4 operator/(float rhs) const
  6378. - Vector4 operator/(const Vector4& rhs) const
  6379. - Vector4 operator/(const Vector4& rhs) const
  6380. - float DotProduct(const Vector4& rhs) const
  6381. - float AbsDotProduct(const Vector4& rhs) const
  6382. - float ProjectOntoAxis(const Vector3& axis) const
  6383. - Vector4 Abs() const
  6384. - Vector4 Lerp(const Vector4& rhs, float t) const
  6385. - bool Equals(const Vector4& rhs) const
  6386. - bool IsNaN() const
  6387. - String ToString() const
  6388. Properties:
  6389. - float x
  6390. - float y
  6391. - float z
  6392. - float w
  6393. - const Vector4 ZERO
  6394. - const Vector4 ONE
  6395. <a name="Class_VectorBuffer"></a>
  6396. ### VectorBuffer
  6397. Methods:
  6398. - VectorBuffer() (GC)
  6399. - VectorBuffer* new()
  6400. - VectorBuffer(Deserializer& source, unsigned size) (GC)
  6401. - VectorBuffer* new(Deserializer& source, unsigned size)
  6402. - void delete()
  6403. - void SetData(Deserializer& source, unsigned size)
  6404. - void Clear()
  6405. - void Resize(unsigned size)
  6406. - const void* GetData() const
  6407. - void* GetModifiableData()
  6408. - VectorBuffer Read(unsigned size)
  6409. - unsigned Seek(unsigned position)
  6410. - const String GetName() const
  6411. - unsigned GetChecksum()
  6412. - unsigned GetPosition() const
  6413. - unsigned GetSize() const
  6414. - bool IsEof() const
  6415. - int ReadInt()
  6416. - long ReadInt64()
  6417. - short ReadShort()
  6418. - char ReadByte()
  6419. - unsigned ReadUInt()
  6420. - long ReadUInt64()
  6421. - short ReadUShort()
  6422. - char ReadUByte()
  6423. - bool ReadBool()
  6424. - float ReadFloat()
  6425. - double ReadDouble()
  6426. - IntRect ReadIntRect()
  6427. - IntVector2 ReadIntVector2()
  6428. - IntVector3 ReadIntVector3()
  6429. - Rect ReadRect()
  6430. - Vector2 ReadVector2()
  6431. - Vector3 ReadVector3()
  6432. - Vector3 ReadPackedVector3(float maxAbsCoord)
  6433. - Vector4 ReadVector4()
  6434. - Quaternion ReadQuaternion()
  6435. - Quaternion ReadPackedQuaternion()
  6436. - Matrix3 ReadMatrix3()
  6437. - Matrix3x4 ReadMatrix3x4()
  6438. - Matrix4 ReadMatrix4()
  6439. - Color ReadColor()
  6440. - BoundingBox ReadBoundingBox()
  6441. - String ReadString()
  6442. - String ReadFileID()
  6443. - StringHash ReadStringHash()
  6444. - VectorBuffer ReadBuffer()
  6445. - ResourceRef ReadResourceRef()
  6446. - ResourceRefList ReadResourceRefList()
  6447. - Variant ReadVariant()
  6448. - Variant ReadVariant(VariantType type)
  6449. - VariantVector ReadVariantVector()
  6450. - VariantMap ReadVariantMap()
  6451. - unsigned ReadVLE()
  6452. - unsigned ReadNetID()
  6453. - String ReadLine()
  6454. - unsigned Write(const VectorBuffer& buffer)
  6455. - bool WriteInt(int value)
  6456. - bool WriteInt64(long value)
  6457. - bool WriteShort(short value)
  6458. - bool WriteByte(char value)
  6459. - bool WriteUInt(unsigned value)
  6460. - bool WriteUInt64(long value)
  6461. - bool WriteUShort(short value)
  6462. - bool WriteUByte(char value)
  6463. - bool WriteBool(bool value)
  6464. - bool WriteFloat(float value)
  6465. - bool WriteDouble(double value)
  6466. - bool WriteIntRect(const IntRect& value)
  6467. - bool WriteIntVector2(const IntVector2& value)
  6468. - bool WriteIntVector3(const IntVector3& value)
  6469. - bool WriteRect(const Rect& value)
  6470. - bool WriteVector2(const Vector2& value)
  6471. - bool WriteVector3(const Vector3& value)
  6472. - bool WritePackedVector3(const Vector3& value, float maxAbsCoord)
  6473. - bool WriteVector4(const Vector4& value)
  6474. - bool WriteQuaternion(const Quaternion& value)
  6475. - bool WritePackedQuaternion(const Quaternion& value)
  6476. - bool WriteMatrix3(const Matrix3& value)
  6477. - bool WriteMatrix3x4(const Matrix3x4& value)
  6478. - bool WriteMatrix4(const Matrix4& value)
  6479. - bool WriteColor(const Color& value)
  6480. - bool WriteBoundingBox(const BoundingBox& value)
  6481. - bool WriteString(const String value)
  6482. - bool WriteFileID(const String value)
  6483. - bool WriteStringHash(const StringHash& value)
  6484. - bool WriteBuffer(const VectorBuffer& buffer)
  6485. - bool WriteResourceRef(const ResourceRef& value)
  6486. - bool WriteResourceRefList(const ResourceRefList& value)
  6487. - bool WriteVariant(const Variant& value)
  6488. - bool WriteVariantData(const Variant& value)
  6489. - bool WriteVariantVector(const VariantVector& value)
  6490. - bool WriteVariantMap(const VariantMap& value)
  6491. - bool WriteVLE(unsigned value)
  6492. - bool WriteNetID(unsigned value)
  6493. - bool WriteLine(const String value)
  6494. Properties:
  6495. - String name (readonly)
  6496. - unsigned checksum (readonly)
  6497. - unsigned position (readonly)
  6498. - unsigned size (readonly)
  6499. - bool eof (readonly)
  6500. <a name="Class_VertexBuffer"></a>
  6501. ### VertexBuffer : Object
  6502. Methods:
  6503. - VertexBuffer() (GC)
  6504. - VertexBuffer* new()
  6505. - void delete()
  6506. - void SetShadowed(bool enable)
  6507. - bool SetSize(unsigned vertexCount, const PODVector<VertexElement>& elements, bool dynamic = false)
  6508. - bool SetSize(unsigned vertexCount, unsigned elementMask, bool dynamic = false)
  6509. - bool SetData(VectorBuffer& data)
  6510. - bool SetDataRange(VectorBuffer& data, unsigned start, unsigned count, bool discard = false)
  6511. - VectorBuffer GetData()
  6512. - bool IsShadowed() const
  6513. - bool IsDynamic() const
  6514. - unsigned GetVertexCount() const
  6515. - unsigned GetVertexSize() const
  6516. - const PODVector<VertexElement>& GetElements() const
  6517. - bool HasElement(VertexElementSemantic semantic, char index = 0) const
  6518. - bool HasElement(VertexElementType type, VertexElementSemantic semantic, char index = 0) const
  6519. - unsigned GetElementOffset(VertexElementSemantic semantic, char index = 0) const
  6520. - unsigned GetElementOffset(VertexElementType type, VertexElementSemantic semantic, char index = 0) const
  6521. - unsigned GetElementMask() const
  6522. Properties:
  6523. - bool shadowed
  6524. - bool dynamic (readonly)
  6525. - unsigned vertexCount (readonly)
  6526. - unsigned vertexSize (readonly)
  6527. - unsigned elementMask (readonly)
  6528. <a name="Class_VertexElement"></a>
  6529. ### VertexElement
  6530. Methods:
  6531. - VertexElement() (GC)
  6532. - VertexElement* new()
  6533. - VertexElement(VertexElementType type, VertexElementSemantic semantic, char index = 0, bool perInstance = false) (GC)
  6534. - VertexElement* new(VertexElementType type, VertexElementSemantic semantic, char index = 0, bool perInstance = false)
  6535. Properties:
  6536. - VertexElementType type
  6537. - VertexElementSemantic semantic
  6538. - char index
  6539. - bool perInstance
  6540. - unsigned offset
  6541. <a name="Class_View3D"></a>
  6542. ### View3D : Window
  6543. Methods:
  6544. - View3D() (GC)
  6545. - View3D* new()
  6546. - void delete()
  6547. - void SetView(Scene* scene, Camera* camera, bool ownScene = true)
  6548. - void SetFormat(unsigned format)
  6549. - void SetAutoUpdate(bool enable)
  6550. - void QueueUpdate()
  6551. - unsigned GetFormat() const
  6552. - bool GetAutoUpdate() const
  6553. - Scene* GetScene() const
  6554. - Node* GetCameraNode() const
  6555. - Texture2D* GetRenderTexture() const
  6556. - Texture2D* GetDepthTexture() const
  6557. - Viewport* GetViewport() const
  6558. Properties:
  6559. - unsigned format
  6560. - bool autoUpdate
  6561. <a name="Class_Viewport"></a>
  6562. ### Viewport
  6563. Methods:
  6564. - Viewport() (GC)
  6565. - Viewport* new()
  6566. - Viewport(Scene* scene, Camera* camera, RenderPath* renderPath = 0) (GC)
  6567. - Viewport* new(Scene* scene, Camera* camera, RenderPath* renderPath = 0)
  6568. - Viewport(Scene* scene, Camera* camera, const IntRect& rect, RenderPath* renderPath = 0) (GC)
  6569. - Viewport* new(Scene* scene, Camera* camera, const IntRect& rect, RenderPath* renderPath = 0)
  6570. - void delete()
  6571. - void SetScene(Scene* scene)
  6572. - void SetCamera(Camera* camera)
  6573. - void SetCullCamera(Camera* camera)
  6574. - void SetRect(const IntRect& rect)
  6575. - void SetRenderPath(RenderPath* path)
  6576. - void SetRenderPath(XMLFile* file)
  6577. - void SetDrawDebug(bool enable)
  6578. - Scene* GetScene() const
  6579. - Camera* GetCamera() const
  6580. - Camera* GetCullCamera() const
  6581. - const IntRect& GetRect() const
  6582. - RenderPath* GetRenderPath() const
  6583. - bool GetDrawDebug() const
  6584. - Ray GetScreenRay(int x, int y) const
  6585. - IntVector2 WorldToScreenPoint(const Vector3& worldPos) const
  6586. - Vector3 ScreenToWorldPoint(int x, int y, float depth) const
  6587. Properties:
  6588. - Scene* scene
  6589. - Camera* camera
  6590. - Camera* cullCamera
  6591. - IntRect& rect
  6592. - RenderPath* renderPath
  6593. - bool drawDebug
  6594. <a name="Class_Window"></a>
  6595. ### Window : BorderImage
  6596. Methods:
  6597. - Window() (GC)
  6598. - Window* new()
  6599. - void delete()
  6600. - void SetMovable(bool enable)
  6601. - void SetResizable(bool enable)
  6602. - void SetFixedWidthResizing(bool enable)
  6603. - void SetFixedHeightResizing(bool enable)
  6604. - void SetResizeBorder(const IntRect& rect)
  6605. - void SetModal(bool modal)
  6606. - void SetModalShadeColor(const Color& color)
  6607. - void SetModalFrameColor(const Color& color)
  6608. - void SetModalFrameSize(const IntVector2& size)
  6609. - void SetModalAutoDismiss(bool enable)
  6610. - bool IsMovable() const
  6611. - bool IsResizable() const
  6612. - bool GetFixedWidthResizing() const
  6613. - bool GetFixedHeightResizing() const
  6614. - const IntRect& GetResizeBorder() const
  6615. - bool IsModal() const
  6616. - const Color& GetModalShadeColor() const
  6617. - const Color& GetModalFrameColor() const
  6618. - const IntVector2& GetModalFrameSize() const
  6619. - bool GetModalAutoDismiss() const
  6620. Properties:
  6621. - bool movable
  6622. - bool resizable
  6623. - bool fixedWidthResizing
  6624. - bool fixedHeightResizing
  6625. - IntRect& resizeBorder
  6626. - bool modal
  6627. - Color& modalShadeColor
  6628. - Color& modalFrameColor
  6629. - IntVector2& modalFrameSize
  6630. - bool modalAutoDismiss
  6631. <a name="Class_XMLElement"></a>
  6632. ### XMLElement
  6633. Methods:
  6634. - XMLElement CreateChild(const String name)
  6635. - XMLElement GetOrCreateChild(const String name)
  6636. - bool RemoveChild(const XMLElement& element)
  6637. - bool RemoveChild(const String name)
  6638. - bool RemoveChildren(const String name = String::EMPTY)
  6639. - bool RemoveAttribute(const String name = String::EMPTY)
  6640. - bool SetValue(const String value)
  6641. - bool SetAttribute(const String name, const String value)
  6642. - bool SetAttribute(const String value)
  6643. - bool SetBool(const String name, bool value)
  6644. - bool SetBoundingBox(const BoundingBox& value)
  6645. - bool SetColor(const String name, const Color& value)
  6646. - bool SetFloat(const String name, float value)
  6647. - bool SetDouble(const String name, double value)
  6648. - bool SetUInt(const String name, unsigned value)
  6649. - bool SetInt(const String name, int value)
  6650. - bool SetIntRect(const String name, const IntRect& value)
  6651. - bool SetIntVector2(const String name, const IntVector2& value)
  6652. - bool SetIntVector3(const String name, const IntVector3& value)
  6653. - bool SetRect(const String name, const Rect& value)
  6654. - bool SetQuaternion(const String name, const Quaternion& value)
  6655. - bool SetString(const String name, const String value)
  6656. - bool SetVariant(const Variant& value)
  6657. - bool SetVariantValue(const Variant& value)
  6658. - bool SetResourceRef(const ResourceRef& value)
  6659. - bool SetResourceRefList(const ResourceRefList& value)
  6660. - bool SetVector2(const String name, const Vector2& value)
  6661. - bool SetVector3(const String name, const Vector3& value)
  6662. - bool SetVector4(const String name, const Vector4& value)
  6663. - bool SetVectorVariant(const String name, const Variant& value)
  6664. - bool SetMatrix3(const String name, const Matrix3& value)
  6665. - bool SetMatrix3x4(const String name, const Matrix3x4& value)
  6666. - bool SetMatrix4(const String name, const Matrix4& value)
  6667. - bool IsNull() const
  6668. - bool NotNull() const
  6669. - bool operatorbool() const
  6670. - String GetName() const
  6671. - bool HasChild(const String name) const
  6672. - XMLElement GetChild(const String name = String::EMPTY) const
  6673. - XMLElement GetNext(const String name = String::EMPTY) const
  6674. - XMLElement GetParent() const
  6675. - unsigned GetNumAttributes() const
  6676. - bool HasAttribute(const String name) const
  6677. - String GetValue() const
  6678. - String GetAttribute(const String name = String::EMPTY) const
  6679. - String GetAttributeLower(const String name) const
  6680. - String GetAttributeUpper(const String name) const
  6681. - Vector<String> GetAttributeNames() const
  6682. - bool GetBool(const String name) const
  6683. - BoundingBox GetBoundingBox() const
  6684. - Color GetColor(const String name) const
  6685. - float GetFloat(const String name) const
  6686. - double GetDouble(const String name) const
  6687. - unsigned GetUInt(const String name) const
  6688. - int GetInt(const String name) const
  6689. - IntRect GetIntRect(const String name) const
  6690. - IntVector2 GetIntVector2(const String name) const
  6691. - IntVector3 GetIntVector3(const String name) const
  6692. - Rect GetRect(const String name) const
  6693. - Quaternion GetQuaternion(const String name) const
  6694. - Variant GetVariant() const
  6695. - Variant GetVariantValue(VariantType type) const
  6696. - ResourceRef GetResourceRef() const
  6697. - ResourceRefList GetResourceRefList() const
  6698. - VariantMap GetVariantMap() const
  6699. - Vector2 GetVector2(const String name) const
  6700. - Vector3 GetVector3(const String name) const
  6701. - Vector4 GetVector4(const String name) const
  6702. - Vector4 GetVector(const String name) const
  6703. - Matrix3 GetMatrix3(const String name) const
  6704. - Matrix3x4 GetMatrix3x4(const String name) const
  6705. - Matrix4 GetMatrix4(const String name) const
  6706. - XMLFile* GetFile() const
  6707. Properties:
  6708. - const XMLElement EMPTY
  6709. - bool null (readonly)
  6710. - String name (readonly)
  6711. - XMLElement parent (readonly)
  6712. - String value (readonly)
  6713. - unsigned numAttributes (readonly)
  6714. - XMLFile* file (readonly)
  6715. <a name="Class_XMLFile"></a>
  6716. ### XMLFile : Resource
  6717. Methods:
  6718. - XMLFile() (GC)
  6719. - XMLFile* new()
  6720. - void delete()
  6721. - bool FromString(const String source)
  6722. - XMLElement CreateRoot(const String name = String::EMPTY)
  6723. - XMLElement GetOrCreateRoot(const String name = String::EMPTY)
  6724. - XMLElement GetRoot(const String name = String::EMPTY)
  6725. - String ToString(const String indentation = "\t") const
  6726. - void Patch(XMLFile* patchFile)
  6727. - void Patch(XMLElement patchElement)
  6728. - bool Save(const String fileName, const String indentation = "\t") const
  6729. <a name="Class_Zone"></a>
  6730. ### Zone : Drawable
  6731. Methods:
  6732. - void SetBoundingBox(const BoundingBox& box)
  6733. - void SetAmbientColor(const Color& color)
  6734. - void SetFogColor(const Color& color)
  6735. - void SetFogStart(float start)
  6736. - void SetFogEnd(float end)
  6737. - void SetFogHeight(float height)
  6738. - void SetFogHeightScale(float scale)
  6739. - void SetPriority(int priority)
  6740. - void SetHeightFog(bool enable)
  6741. - void SetOverride(bool enable)
  6742. - void SetAmbientGradient(bool enable)
  6743. - void SetZoneTexture(Texture* texture)
  6744. - const Matrix3x4& GetInverseWorldTransform() const
  6745. - const Color& GetAmbientColor() const
  6746. - const Color& GetAmbientStartColor()
  6747. - const Color& GetAmbientEndColor()
  6748. - const Color& GetFogColor() const
  6749. - float GetFogStart() const
  6750. - float GetFogEnd() const
  6751. - float GetFogHeight() const
  6752. - float GetFogHeightScale() const
  6753. - int GetPriority() const
  6754. - bool GetHeightFog() const
  6755. - bool GetOverride() const
  6756. - bool GetAmbientGradient() const
  6757. - Texture* GetZoneTexture() const
  6758. - bool IsInside(const Vector3& point) const
  6759. Properties:
  6760. - BoundingBox& boundingBox
  6761. - Matrix3x4& inverseWorldTransform (readonly)
  6762. - Color& ambientColor
  6763. - Color& ambientStartColor (readonly)
  6764. - Color& ambientEndColor (readonly)
  6765. - Color& fogColor
  6766. - float fogStart
  6767. - float fogEnd
  6768. - float fogHeight
  6769. - float fogHeightScale
  6770. - int priority
  6771. - bool heightFog
  6772. - bool override
  6773. - bool ambientGradient
  6774. - Texture* zoneTexture
  6775. \section LuaScriptAPI_Enums Enumerations
  6776. ### AnimationBlendMode
  6777. - int ABM_LERP
  6778. - int ABM_ADDITIVE
  6779. ### AutoRemoveMode
  6780. - int REMOVE_DISABLED
  6781. - int REMOVE_COMPONENT
  6782. - int REMOVE_NODE
  6783. ### BlendMode
  6784. - int BLEND_REPLACE
  6785. - int BLEND_ADD
  6786. - int BLEND_MULTIPLY
  6787. - int BLEND_ALPHA
  6788. - int BLEND_ADDALPHA
  6789. - int BLEND_PREMULALPHA
  6790. - int BLEND_INVDESTALPHA
  6791. - int BLEND_SUBTRACT
  6792. - int BLEND_SUBTRACTALPHA
  6793. - int MAX_BLENDMODES
  6794. ### BodyType2D
  6795. - int BT_STATIC
  6796. - int BT_KINEMATIC
  6797. - int BT_DYNAMIC
  6798. ### CollisionEventMode
  6799. - int COLLISION_NEVER
  6800. - int COLLISION_ACTIVE
  6801. - int COLLISION_ALWAYS
  6802. ### CompareMode
  6803. - int CMP_ALWAYS
  6804. - int CMP_EQUAL
  6805. - int CMP_NOTEQUAL
  6806. - int CMP_LESS
  6807. - int CMP_LESSEQUAL
  6808. - int CMP_GREATER
  6809. - int CMP_GREATEREQUAL
  6810. - int MAX_COMPAREMODES
  6811. ### CompressedFormat
  6812. - int CF_NONE
  6813. - int CF_RGBA
  6814. - int CF_DXT1
  6815. - int CF_DXT3
  6816. - int CF_DXT5
  6817. - int CF_ETC1
  6818. - int CF_PVRTC_RGB_2BPP
  6819. - int CF_PVRTC_RGBA_2BPP
  6820. - int CF_PVRTC_RGB_4BPP
  6821. - int CF_PVRTC_RGBA_4BPP
  6822. ### ConstraintType
  6823. - int CONSTRAINT_POINT
  6824. - int CONSTRAINT_HINGE
  6825. - int CONSTRAINT_SLIDER
  6826. - int CONSTRAINT_CONETWIST
  6827. ### Corner
  6828. - int C_TOPLEFT
  6829. - int C_TOPRIGHT
  6830. - int C_BOTTOMLEFT
  6831. - int C_BOTTOMRIGHT
  6832. - int MAX_UIELEMENT_CORNERS
  6833. ### CreateMode
  6834. - int REPLICATED
  6835. - int LOCAL
  6836. ### CrowdAgentRequestedTarget
  6837. - int CA_REQUESTEDTARGET_NONE
  6838. - int CA_REQUESTEDTARGET_POSITION
  6839. - int CA_REQUESTEDTARGET_VELOCITY
  6840. ### CrowdAgentState
  6841. - int CA_STATE_INVALID
  6842. - int CA_STATE_WALKING
  6843. - int CA_STATE_OFFMESH
  6844. ### CrowdAgentTargetState
  6845. - int CA_TARGET_NONE
  6846. - int CA_TARGET_FAILED
  6847. - int CA_TARGET_VALID
  6848. - int CA_TARGET_REQUESTING
  6849. - int CA_TARGET_WAITINGFORQUEUE
  6850. - int CA_TARGET_WAITINGFORPATH
  6851. - int CA_TARGET_VELOCITY
  6852. ### CubeMapFace
  6853. - int FACE_POSITIVE_X
  6854. - int FACE_NEGATIVE_X
  6855. - int FACE_POSITIVE_Y
  6856. - int FACE_NEGATIVE_Y
  6857. - int FACE_POSITIVE_Z
  6858. - int FACE_NEGATIVE_Z
  6859. - int MAX_CUBEMAP_FACES
  6860. ### CullMode
  6861. - int CULL_NONE
  6862. - int CULL_CCW
  6863. - int CULL_CW
  6864. - int MAX_CULLMODES
  6865. ### CursorShape
  6866. - int CS_NORMAL
  6867. - int CS_IBEAM
  6868. - int CS_CROSS
  6869. - int CS_RESIZEVERTICAL
  6870. - int CS_RESIZEDIAGONAL_TOPRIGHT
  6871. - int CS_RESIZEHORIZONTAL
  6872. - int CS_RESIZEDIAGONAL_TOPLEFT
  6873. - int CS_RESIZE_ALL
  6874. - int CS_ACCEPTDROP
  6875. - int CS_REJECTDROP
  6876. - int CS_BUSY
  6877. - int CS_BUSY_ARROW
  6878. - int CS_MAX_SHAPES
  6879. ### DBAPI
  6880. - int DBAPI_SQLITE
  6881. - int DBAPI_ODBC
  6882. ### EmitterType
  6883. - int EMITTER_SPHERE
  6884. - int EMITTER_BOX
  6885. ### EmitterType2D
  6886. - int EMITTER_TYPE_GRAVITY
  6887. - int EMITTER_TYPE_RADIAL
  6888. ### FaceCameraMode
  6889. - int FC_NONE
  6890. - int FC_ROTATE_XYZ
  6891. - int FC_ROTATE_Y
  6892. - int FC_LOOKAT_XYZ
  6893. - int FC_LOOKAT_Y
  6894. - int FC_LOOKAT_MIXED
  6895. - int FC_DIRECTION
  6896. ### FaceCameraMode
  6897. - int FC_NONE
  6898. - int FC_ROTATE_XYZ
  6899. - int FC_ROTATE_Y
  6900. - int FC_LOOKAT_XYZ
  6901. - int FC_LOOKAT_Y
  6902. - int FC_LOOKAT_MIXED
  6903. - int FC_DIRECTION
  6904. ### FileMode
  6905. - int FILE_READ
  6906. - int FILE_WRITE
  6907. - int FILE_READWRITE
  6908. ### FillMode
  6909. - int FILL_SOLID
  6910. - int FILL_WIREFRAME
  6911. - int FILL_POINT
  6912. ### FocusMode
  6913. - int FM_NOTFOCUSABLE
  6914. - int FM_RESETFOCUS
  6915. - int FM_FOCUSABLE
  6916. - int FM_FOCUSABLE_DEFOCUSABLE
  6917. ### FontType
  6918. - int FONT_NONE
  6919. - int FONT_FREETYPE
  6920. - int FONT_BITMAP
  6921. - int MAX_FONT_TYPES
  6922. ### FrustumPlane
  6923. - int PLANE_NEAR
  6924. - int PLANE_LEFT
  6925. - int PLANE_RIGHT
  6926. - int PLANE_UP
  6927. - int PLANE_DOWN
  6928. - int PLANE_FAR
  6929. ### GeometryType
  6930. - int GEOM_STATIC
  6931. - int GEOM_SKINNED
  6932. - int GEOM_INSTANCED
  6933. - int GEOM_BILLBOARD
  6934. - int GEOM_STATIC_NOINSTANCING
  6935. - int MAX_GEOMETRYTYPES
  6936. ### HighlightMode
  6937. - int HM_NEVER
  6938. - int HM_FOCUS
  6939. - int HM_ALWAYS
  6940. ### HorizontalAlignment
  6941. - int HA_LEFT
  6942. - int HA_CENTER
  6943. - int HA_RIGHT
  6944. - int HA_CUSTOM
  6945. ### HttpRequestState
  6946. - int HTTP_INITIALIZING
  6947. - int HTTP_ERROR
  6948. - int HTTP_OPEN
  6949. - int HTTP_CLOSED
  6950. ### InterpMethod
  6951. - int IM_NONE
  6952. - int IM_LINEAR
  6953. - int IM_SPLINE
  6954. ### InterpolationMode
  6955. - int BEZIER_CURVE
  6956. - int CATMULL_ROM_CURVE
  6957. - int LINEAR_CURVE
  6958. - int CATMULL_ROM_FULL_CURVE
  6959. ### Intersection
  6960. - int OUTSIDE
  6961. - int INTERSECTS
  6962. - int INSIDE
  6963. ### JSONNumberType
  6964. - int JSONNT_NAN
  6965. - int JSONNT_INT
  6966. - int JSONNT_UINT
  6967. - int JSONNT_FLOAT_DOUBLE
  6968. ### JSONValueType
  6969. - int JSON_NULL
  6970. - int JSON_BOOL
  6971. - int JSON_NUMBER
  6972. - int JSON_STRING
  6973. - int JSON_ARRAY
  6974. - int JSON_OBJECT
  6975. ### LayoutMode
  6976. - int LM_FREE
  6977. - int LM_HORIZONTAL
  6978. - int LM_VERTICAL
  6979. ### LegacyVertexElement
  6980. - int ELEMENT_POSITION
  6981. - int ELEMENT_NORMAL
  6982. - int ELEMENT_COLOR
  6983. - int ELEMENT_TEXCOORD1
  6984. - int ELEMENT_TEXCOORD2
  6985. - int ELEMENT_CUBETEXCOORD1
  6986. - int ELEMENT_CUBETEXCOORD2
  6987. - int ELEMENT_TANGENT
  6988. - int ELEMENT_BLENDWEIGHTS
  6989. - int ELEMENT_BLENDINDICES
  6990. - int ELEMENT_INSTANCEMATRIX1
  6991. - int ELEMENT_INSTANCEMATRIX2
  6992. - int ELEMENT_INSTANCEMATRIX3
  6993. - int ELEMENT_OBJECTINDEX
  6994. - int MAX_LEGACY_VERTEX_ELEMENTS
  6995. ### LightType
  6996. - int LIGHT_DIRECTIONAL
  6997. - int LIGHT_SPOT
  6998. - int LIGHT_POINT
  6999. ### LoadMode
  7000. - int LOAD_RESOURCES_ONLY
  7001. - int LOAD_SCENE
  7002. - int LOAD_SCENE_AND_RESOURCES
  7003. ### LockState
  7004. - int LOCK_NONE
  7005. - int LOCK_HARDWARE
  7006. - int LOCK_SHADOW
  7007. - int LOCK_SCRATCH
  7008. ### LoopMode2D
  7009. - int LM_DEFAULT
  7010. - int LM_FORCE_LOOPED
  7011. - int LM_FORCE_CLAMPED
  7012. ### MouseMode
  7013. - int MM_ABSOLUTE
  7014. - int MM_RELATIVE
  7015. - int MM_WRAP
  7016. - int MM_FREE
  7017. ### NavigationPushiness
  7018. - int NAVIGATIONPUSHINESS_LOW
  7019. - int NAVIGATIONPUSHINESS_MEDIUM
  7020. - int NAVIGATIONPUSHINESS_HIGH
  7021. - int NAVIGATIONPUSHINESS_NONE
  7022. ### NavigationQuality
  7023. - int NAVIGATIONQUALITY_LOW
  7024. - int NAVIGATIONQUALITY_MEDIUM
  7025. - int NAVIGATIONQUALITY_HIGH
  7026. ### NavmeshPartitionType
  7027. - int NAVMESH_PARTITION_WATERSHED
  7028. - int NAVMESH_PARTITION_MONOTONE
  7029. ### Orientation
  7030. - int O_HORIZONTAL
  7031. - int O_VERTICAL
  7032. ### Orientation2D
  7033. - int O_ORTHOGONAL
  7034. - int O_ISOMETRIC
  7035. - int O_STAGGERED
  7036. - int O_HEXAGONAL
  7037. ### PassLightingMode
  7038. - int LIGHTING_UNLIT
  7039. - int LIGHTING_PERVERTEX
  7040. - int LIGHTING_PERPIXEL
  7041. ### PrimitiveType
  7042. - int TRIANGLE_LIST
  7043. - int LINE_LIST
  7044. - int POINT_LIST
  7045. - int TRIANGLE_STRIP
  7046. - int LINE_STRIP
  7047. - int TRIANGLE_FAN
  7048. ### RayQueryLevel
  7049. - int RAY_AABB
  7050. - int RAY_OBB
  7051. - int RAY_TRIANGLE
  7052. - int RAY_TRIANGLE_UV
  7053. ### RenderCommandSortMode
  7054. - int SORT_FRONTTOBACK
  7055. - int SORT_BACKTOFRONT
  7056. ### RenderCommandType
  7057. - int CMD_NONE
  7058. - int CMD_CLEAR
  7059. - int CMD_SCENEPASS
  7060. - int CMD_QUAD
  7061. - int CMD_FORWARDLIGHTS
  7062. - int CMD_LIGHTVOLUMES
  7063. - int CMD_RENDERUI
  7064. - int CMD_SENDEVENT
  7065. ### RenderSurfaceUpdateMode
  7066. - int SURFACE_MANUALUPDATE
  7067. - int SURFACE_UPDATEVISIBLE
  7068. - int SURFACE_UPDATEALWAYS
  7069. ### RenderTargetSizeMode
  7070. - int SIZE_ABSOLUTE
  7071. - int SIZE_VIEWPORTDIVISOR
  7072. - int SIZE_VIEWPORTMULTIPLIER
  7073. ### ShaderType
  7074. - int VS
  7075. - int PS
  7076. ### ShadowQuality
  7077. - int SHADOWQUALITY_SIMPLE_16BIT
  7078. - int SHADOWQUALITY_SIMPLE_24BIT
  7079. - int SHADOWQUALITY_PCF_16BIT
  7080. - int SHADOWQUALITY_PCF_24BIT
  7081. - int SHADOWQUALITY_VSM
  7082. - int SHADOWQUALITY_BLUR_VSM
  7083. ### ShapeType
  7084. - int SHAPE_BOX
  7085. - int SHAPE_SPHERE
  7086. - int SHAPE_STATICPLANE
  7087. - int SHAPE_CYLINDER
  7088. - int SHAPE_CAPSULE
  7089. - int SHAPE_CONE
  7090. - int SHAPE_TRIANGLEMESH
  7091. - int SHAPE_CONVEXHULL
  7092. - int SHAPE_TERRAIN
  7093. ### StencilOp
  7094. - int OP_KEEP
  7095. - int OP_ZERO
  7096. - int OP_REF
  7097. - int OP_INCR
  7098. - int OP_DECR
  7099. ### TextEffect
  7100. - int TE_NONE
  7101. - int TE_SHADOW
  7102. - int TE_STROKE
  7103. ### TextureAddressMode
  7104. - int ADDRESS_WRAP
  7105. - int ADDRESS_MIRROR
  7106. - int ADDRESS_CLAMP
  7107. - int ADDRESS_BORDER
  7108. - int MAX_ADDRESSMODES
  7109. ### TextureCoordinate
  7110. - int COORD_U
  7111. - int COORD_V
  7112. - int COORD_W
  7113. - int MAX_COORDS
  7114. ### TextureFilterMode
  7115. - int FILTER_NEAREST
  7116. - int FILTER_BILINEAR
  7117. - int FILTER_TRILINEAR
  7118. - int FILTER_ANISOTROPIC
  7119. - int FILTER_NEAREST_ANISOTROPIC
  7120. - int FILTER_DEFAULT
  7121. - int MAX_FILTERMODES
  7122. ### TextureUnit
  7123. - int TU_DIFFUSE
  7124. - int TU_ALBEDOBUFFER
  7125. - int TU_NORMAL
  7126. - int TU_NORMALBUFFER
  7127. - int TU_SPECULAR
  7128. - int TU_EMISSIVE
  7129. - int TU_ENVIRONMENT
  7130. ### TextureUsage
  7131. - int TEXTURE_STATIC
  7132. - int TEXTURE_DYNAMIC
  7133. - int TEXTURE_RENDERTARGET
  7134. - int TEXTURE_DEPTHSTENCIL
  7135. ### TileMapLayerType2D
  7136. - int LT_TILE_LAYER
  7137. - int LT_OBJECT_GROUP
  7138. - int LT_IMAGE_LAYER
  7139. - int LT_INVALID
  7140. ### TileMapObjectType2D
  7141. - int OT_RECTANGLE
  7142. - int OT_ELLIPSE
  7143. - int OT_POLYGON
  7144. - int OT_POLYLINE
  7145. - int OT_TILE
  7146. - int OT_INVALID
  7147. ### TrailType
  7148. - int TT_FACE_CAMERA
  7149. - int TT_BONE
  7150. ### TransformSpace
  7151. - int TS_LOCAL
  7152. - int TS_PARENT
  7153. - int TS_WORLD
  7154. ### TraversalMode
  7155. - int TM_BREADTH_FIRST
  7156. - int TM_DEPTH_FIRST
  7157. ### VariantType
  7158. - int VAR_NONE
  7159. - int VAR_INT
  7160. - int VAR_BOOL
  7161. - int VAR_FLOAT
  7162. - int VAR_VECTOR2
  7163. - int VAR_VECTOR3
  7164. - int VAR_VECTOR4
  7165. - int VAR_QUATERNION
  7166. - int VAR_COLOR
  7167. - int VAR_STRING
  7168. - int VAR_BUFFER
  7169. - int VAR_VOIDPTR
  7170. - int VAR_RESOURCEREF
  7171. - int VAR_RESOURCEREFLIST
  7172. - int VAR_VARIANTVECTOR
  7173. - int VAR_VARIANTMAP
  7174. - int VAR_INTRECT
  7175. - int VAR_INTVECTOR2
  7176. - int VAR_PTR
  7177. - int VAR_MATRIX3
  7178. - int VAR_MATRIX3X4
  7179. - int VAR_MATRIX4
  7180. - int VAR_DOUBLE
  7181. - int VAR_STRINGVECTOR
  7182. - int VAR_RECT
  7183. - int VAR_INTVECTOR3
  7184. - int MAX_VAR_TYPES
  7185. ### VertexElementSemantic
  7186. - int SEM_POSITION
  7187. - int SEM_NORMAL
  7188. - int SEM_BINORMAL
  7189. - int SEM_TANGENT
  7190. - int SEM_TEXCOORD
  7191. - int SEM_COLOR
  7192. - int SEM_BLENDWEIGHTS
  7193. - int SEM_BLENDINDICES
  7194. - int SEM_OBJECTINDEX
  7195. - int MAX_VERTEX_ELEMENT_SEMANTICS
  7196. ### VertexElementType
  7197. - int TYPE_INT
  7198. - int TYPE_FLOAT
  7199. - int TYPE_VECTOR2
  7200. - int TYPE_VECTOR3
  7201. - int TYPE_VECTOR4
  7202. - int TYPE_UBYTE4
  7203. - int TYPE_UBYTE4_NORM
  7204. - int MAX_VERTEX_ELEMENT_TYPES
  7205. ### VerticalAlignment
  7206. - int VA_TOP
  7207. - int VA_CENTER
  7208. - int VA_BOTTOM
  7209. - int VA_CUSTOM
  7210. ### WindowDragMode
  7211. - int DRAG_NONE
  7212. - int DRAG_MOVE
  7213. - int DRAG_RESIZE_TOPLEFT
  7214. - int DRAG_RESIZE_TOP
  7215. - int DRAG_RESIZE_TOPRIGHT
  7216. - int DRAG_RESIZE_RIGHT
  7217. - int DRAG_RESIZE_BOTTOMRIGHT
  7218. - int DRAG_RESIZE_BOTTOM
  7219. - int DRAG_RESIZE_BOTTOMLEFT
  7220. - int DRAG_RESIZE_LEFT
  7221. ### WrapMode
  7222. - int WM_LOOP
  7223. - int WM_ONCE
  7224. - int WM_CLAMP
  7225. \section LuaScriptAPI_toluaFunctions tolua functions
  7226. - lua_usertype cast(lua_usertype object, const char* typename)
  7227. - lua_table getpeer(lua_userdata object)
  7228. - void inherit(lua_table table, lua_usertype c_instance)
  7229. - bool releaseownership(lua_usertype object)
  7230. - void setpeer(lua_userdata object, lua_table table)
  7231. - bool takeownership(lua_usertype object)
  7232. - const char* type(lua_object object)
  7233. \section LuaScriptAPI_GlobalFunctions Global functions
  7234. - float Abs(float value)
  7235. - int AbsInt(int value)
  7236. - float Acos(float x)
  7237. - String AddTrailingSlash(const String pathName)
  7238. - float Asin(float x)
  7239. - float Atan(float x)
  7240. - float Atan2(float y, float x)
  7241. - float Ceil(float x)
  7242. - int CeilToInt(float x)
  7243. - float Clamp(float value, float min, float max)
  7244. - int ClampInt(int value, int min, int max)
  7245. - VectorBuffer CompressVectorBuffer(VectorBuffer& src)
  7246. - float Cos(float angle)
  7247. - unsigned CountSetBits(unsigned value)
  7248. - VectorBuffer DecompressVectorBuffer(VectorBuffer& src)
  7249. - bool Equals(float lhs, float rhs)
  7250. - void ErrorDialog(const String title, const String message)
  7251. - void ErrorExit(const String message = String::EMPTY, int exitCode = EXIT_FAILURE)
  7252. - float Floor(float x)
  7253. - int FloorToInt(float x)
  7254. - float Fract(float x)
  7255. - const Vector<String>& GetArguments()
  7256. - Audio* GetAudio()
  7257. - ResourceCache* GetCache()
  7258. - Console* GetConsole()
  7259. - String GetConsoleInput()
  7260. - Context* GetContext()
  7261. - DBAPI GetDBAPI()
  7262. - Database* GetDatabase()
  7263. - DebugHud* GetDebugHud()
  7264. - Engine* GetEngine()
  7265. - EventHandler* GetEventHandler() const
  7266. - Object* GetEventSender()
  7267. - bool GetExecuteConsoleCommands()
  7268. - String GetExtension(const String fullPath, bool lowercaseExtension = true)
  7269. - String GetFileName(const String fullPath)
  7270. - String GetFileNameAndExtension(const String fullPath, bool lowercaseExtension = false)
  7271. - String GetFileSizeString(long memorySize)
  7272. - FileSystem* GetFileSystem()
  7273. - Variant GetGlobalVar(const String key)
  7274. - VariantMap& GetGlobalVars()
  7275. - Graphics* GetGraphics()
  7276. - Input* GetInput()
  7277. - String GetInternalPath(const String pathName)
  7278. - Localization* GetLocalization()
  7279. - Log* GetLog()
  7280. - String GetMiniDumpDir()
  7281. - String GetNativePath(const String pathName)
  7282. - Network* GetNetwork()
  7283. - unsigned GetNumLogicalCPUs()
  7284. - unsigned GetNumPhysicalCPUs()
  7285. - String GetParentPath(const String pathName)
  7286. - String GetPath(const String fullPath)
  7287. - String GetPlatform()
  7288. - unsigned GetRandomSeed()
  7289. - Renderer* GetRenderer()
  7290. - Time* GetTime()
  7291. - UI* GetUI()
  7292. - bool HasSubscribedToEvent(Object* sender, const String eventName)
  7293. - bool HasSubscribedToEvent(const String eventName)
  7294. - float InverseLerp(float lhs, float rhs, float x)
  7295. - bool IsAbsolutePath(const String pathName)
  7296. - bool IsAlpha(unsigned ch)
  7297. - bool IsDigit(unsigned ch)
  7298. - bool IsNaN(float value)
  7299. - bool IsPowerOfTwo(unsigned value)
  7300. - float Lerp(float lhs, float rhs, float t)
  7301. - float Ln(float x)
  7302. - float Max(float lhs, float rhs)
  7303. - int MaxInt(int lhs, int rhs)
  7304. - float Min(float lhs, float rhs)
  7305. - int MinInt(int lhs, int rhs)
  7306. - float Mod(float x, float y)
  7307. - unsigned NextPowerOfTwo(unsigned value)
  7308. - void OpenConsoleWindow()
  7309. - float Pow(float x, float y)
  7310. - void PrintLine(const String str, bool error = false)
  7311. - int Rand()
  7312. - float RandStandardNormal()
  7313. - float Random()
  7314. - float Random(float range)
  7315. - float Random(float min, float max)
  7316. - int RandomInt(int range)
  7317. - int RandomInt(int min, int max)
  7318. - float RandomNormal(float meanValue, float variance)
  7319. - void RegisterEventName(const String eventName)
  7320. - String RemoveTrailingSlash(const String pathName)
  7321. - String ReplaceExtension(const String fullPath, const String newExtension)
  7322. - float Round(float x)
  7323. - int RoundToInt(float x)
  7324. - unsigned SDBMHash(unsigned hash, char c)
  7325. - void SendEvent(const String eventName, VariantMap& eventData)
  7326. - void SetExecuteConsoleCommands(bool enable)
  7327. - void SetGlobalVar(const String key, Variant value)
  7328. - void SetMiniDumpDir(const String pathName)
  7329. - void SetRandomSeed(unsigned seed)
  7330. - float Sign(float value)
  7331. - float Sin(float angle)
  7332. - float SmoothStep(float lhs, float rhs, float t)
  7333. - float Sqrt(float x)
  7334. - float StableRandom(float seed)
  7335. - float StableRandom(const Vector3& seed)
  7336. - float StableRandom(const Vector2& seed)
  7337. - void SubscribeToEvent(void* sender, const String eventName, void* functionOrFunctionName)
  7338. - void SubscribeToEvent(const String eventName, void* functionOrFunctionName)
  7339. - float Tan(float angle)
  7340. - bool ToBool(const String source)
  7341. - Color ToColor(const String source)
  7342. - float ToFloat(const String source)
  7343. - int ToInt(const String source, int base = 10)
  7344. - IntRect ToIntRect(const String source)
  7345. - IntVector2 ToIntVector2(const String source)
  7346. - IntVector3 ToIntVector3(const String source)
  7347. - unsigned ToLower(unsigned ch)
  7348. - Matrix3 ToMatrix3(const String source)
  7349. - Matrix3x4 ToMatrix3x4(const String source)
  7350. - Matrix4 ToMatrix4(const String source)
  7351. - Quaternion ToQuaternion(const String source)
  7352. - Rect ToRect(const String source)
  7353. - String ToString(void* value)
  7354. - String ToStringHex(unsigned value)
  7355. - unsigned ToUInt(const String source, int base = 10)
  7356. - unsigned ToUpper(unsigned ch)
  7357. - Vector2 ToVector2(const String source)
  7358. - Vector3 ToVector3(const String source)
  7359. - Vector4 ToVector4(const String source, bool allowMissingCoords = false)
  7360. - void UnsubscribeFromAllEvents()
  7361. - void UnsubscribeFromAllEventsExcept(const Vector<String>& exceptionNames)
  7362. - void UnsubscribeFromEvent(const String eventName)
  7363. - void UnsubscribeFromEvent(Object* sender, const String eventName)
  7364. - void UnsubscribeFromEvents(Object* sender)
  7365. - Vector2 VectorCeil(const Vector2& vec)
  7366. - Vector4 VectorCeil(const Vector4& vec)
  7367. - Vector3 VectorCeil(const Vector3& vec)
  7368. - IntVector2 VectorCeilToInt(const Vector2& vec)
  7369. - IntVector3 VectorCeilToInt(const Vector3& vec)
  7370. - Vector4 VectorFloor(const Vector4& vec)
  7371. - Vector3 VectorFloor(const Vector3& vec)
  7372. - Vector2 VectorFloor(const Vector2& vec)
  7373. - IntVector3 VectorFloorToInt(const Vector3& vec)
  7374. - IntVector2 VectorFloorToInt(const Vector2& vec)
  7375. - Vector2 VectorLerp(const Vector2& lhs, const Vector2& rhs, const Vector2& t)
  7376. - Vector3 VectorLerp(const Vector3& lhs, const Vector3& rhs, const Vector3& t)
  7377. - Vector4 VectorLerp(const Vector4& lhs, const Vector4& rhs, const Vector4& t)
  7378. - Vector4 VectorMax(const Vector4& lhs, const Vector4& rhs)
  7379. - IntVector3 VectorMax(const IntVector3& lhs, const IntVector3& rhs)
  7380. - Vector2 VectorMax(const Vector2& lhs, const Vector2& rhs)
  7381. - Vector3 VectorMax(const Vector3& lhs, const Vector3& rhs)
  7382. - IntVector2 VectorMax(const IntVector2& lhs, const IntVector2& rhs)
  7383. - Vector2 VectorMin(const Vector2& lhs, const Vector2& rhs)
  7384. - IntVector3 VectorMin(const IntVector3& lhs, const IntVector3& rhs)
  7385. - Vector4 VectorMin(const Vector4& lhs, const Vector4& rhs)
  7386. - IntVector2 VectorMin(const IntVector2& lhs, const IntVector2& rhs)
  7387. - Vector3 VectorMin(const Vector3& lhs, const Vector3& rhs)
  7388. - Vector2 VectorRound(const Vector2& vec)
  7389. - Vector3 VectorRound(const Vector3& vec)
  7390. - Vector4 VectorRound(const Vector4& vec)
  7391. - IntVector3 VectorRoundToInt(const Vector3& vec)
  7392. - IntVector2 VectorRoundToInt(const Vector2& vec)
  7393. \section LuaScriptAPI_GlobalProperties Global properties
  7394. - Audio* audio (readonly)
  7395. - ResourceCache* cache (readonly)
  7396. - Console* console (readonly)
  7397. - Context* context (readonly)
  7398. - Database* database (readonly)
  7399. - DebugHud* debugHud (readonly)
  7400. - Engine* engine (readonly)
  7401. - EventHandler* eventHandler (readonly)
  7402. - EventSender* eventSender (readonly)
  7403. - FileSystem* fileSystem (readonly)
  7404. - Graphics* graphics (readonly)
  7405. - Input* input (readonly)
  7406. - Localization* localization (readonly)
  7407. - Log* log (readonly)
  7408. - Network* network (readonly)
  7409. - Renderer* renderer (readonly)
  7410. - Time* time (readonly)
  7411. - UI* ui (readonly)
  7412. \section LuaScriptAPI_GlobalConstants Global constants
  7413. - float ANIMATION_LOD_BASESCALE
  7414. - char CHANNEL_POSITION
  7415. - char CHANNEL_ROTATION
  7416. - char CHANNEL_SCALE
  7417. - unsigned CLEAR_COLOR
  7418. - unsigned CLEAR_DEPTH
  7419. - unsigned CLEAR_STENCIL
  7420. - int CONTROLLER_AXIS_LEFTX
  7421. - int CONTROLLER_AXIS_LEFTY
  7422. - int CONTROLLER_AXIS_RIGHTX
  7423. - int CONTROLLER_AXIS_RIGHTY
  7424. - int CONTROLLER_AXIS_TRIGGERLEFT
  7425. - int CONTROLLER_AXIS_TRIGGERRIGHT
  7426. - int CONTROLLER_BUTTON_A
  7427. - int CONTROLLER_BUTTON_B
  7428. - int CONTROLLER_BUTTON_BACK
  7429. - int CONTROLLER_BUTTON_DPAD_DOWN
  7430. - int CONTROLLER_BUTTON_DPAD_LEFT
  7431. - int CONTROLLER_BUTTON_DPAD_RIGHT
  7432. - int CONTROLLER_BUTTON_DPAD_UP
  7433. - int CONTROLLER_BUTTON_GUIDE
  7434. - int CONTROLLER_BUTTON_LEFTSHOULDER
  7435. - int CONTROLLER_BUTTON_LEFTSTICK
  7436. - int CONTROLLER_BUTTON_RIGHTSHOULDER
  7437. - int CONTROLLER_BUTTON_RIGHTSTICK
  7438. - int CONTROLLER_BUTTON_START
  7439. - int CONTROLLER_BUTTON_X
  7440. - int CONTROLLER_BUTTON_Y
  7441. - unsigned DD_DISABLED
  7442. - unsigned DD_SOURCE
  7443. - unsigned DD_SOURCE_AND_TARGET
  7444. - unsigned DD_TARGET
  7445. - unsigned DEBUGHUD_SHOW_ALL
  7446. - unsigned DEBUGHUD_SHOW_EVENTPROFILER
  7447. - unsigned DEBUGHUD_SHOW_MEMORY
  7448. - unsigned DEBUGHUD_SHOW_MODE
  7449. - unsigned DEBUGHUD_SHOW_NONE
  7450. - unsigned DEBUGHUD_SHOW_PROFILER
  7451. - unsigned DEBUGHUD_SHOW_STATS
  7452. - unsigned DEFAULT_LIGHTMASK
  7453. - unsigned DEFAULT_SHADOWMASK
  7454. - unsigned DEFAULT_VIEWMASK
  7455. - unsigned DEFAULT_ZONEMASK
  7456. - unsigned DRAWABLE_ANY
  7457. - unsigned DRAWABLE_GEOMETRY
  7458. - unsigned DRAWABLE_GEOMETRY2D
  7459. - unsigned DRAWABLE_LIGHT
  7460. - unsigned DRAWABLE_ZONE
  7461. - unsigned FIRST_LOCAL_ID
  7462. - unsigned FIRST_REPLICATED_ID
  7463. - int HAT_CENTER
  7464. - int HAT_DOWN
  7465. - int HAT_LEFT
  7466. - int HAT_RIGHT
  7467. - int HAT_UP
  7468. - int KEY_0
  7469. - int KEY_1
  7470. - int KEY_2
  7471. - int KEY_3
  7472. - int KEY_4
  7473. - int KEY_5
  7474. - int KEY_6
  7475. - int KEY_7
  7476. - int KEY_8
  7477. - int KEY_9
  7478. - int KEY_A
  7479. - int KEY_ALT
  7480. - int KEY_APPLICATION
  7481. - int KEY_B
  7482. - int KEY_BACKSPACE
  7483. - int KEY_C
  7484. - int KEY_CAPSLOCK
  7485. - int KEY_CTRL
  7486. - int KEY_D
  7487. - int KEY_DELETE
  7488. - int KEY_DOWN
  7489. - int KEY_E
  7490. - int KEY_END
  7491. - int KEY_ESCAPE
  7492. - int KEY_F
  7493. - int KEY_F1
  7494. - int KEY_F10
  7495. - int KEY_F11
  7496. - int KEY_F12
  7497. - int KEY_F13
  7498. - int KEY_F14
  7499. - int KEY_F15
  7500. - int KEY_F16
  7501. - int KEY_F17
  7502. - int KEY_F18
  7503. - int KEY_F19
  7504. - int KEY_F2
  7505. - int KEY_F20
  7506. - int KEY_F21
  7507. - int KEY_F22
  7508. - int KEY_F23
  7509. - int KEY_F24
  7510. - int KEY_F3
  7511. - int KEY_F4
  7512. - int KEY_F5
  7513. - int KEY_F6
  7514. - int KEY_F7
  7515. - int KEY_F8
  7516. - int KEY_F9
  7517. - int KEY_G
  7518. - int KEY_GUI
  7519. - int KEY_H
  7520. - int KEY_HOME
  7521. - int KEY_I
  7522. - int KEY_INSERT
  7523. - int KEY_J
  7524. - int KEY_K
  7525. - int KEY_KP_0
  7526. - int KEY_KP_1
  7527. - int KEY_KP_2
  7528. - int KEY_KP_3
  7529. - int KEY_KP_4
  7530. - int KEY_KP_5
  7531. - int KEY_KP_6
  7532. - int KEY_KP_7
  7533. - int KEY_KP_8
  7534. - int KEY_KP_9
  7535. - int KEY_KP_DIVIDE
  7536. - int KEY_KP_ENTER
  7537. - int KEY_KP_MINUS
  7538. - int KEY_KP_MULTIPLY
  7539. - int KEY_KP_PERIOD
  7540. - int KEY_KP_PLUS
  7541. - int KEY_L
  7542. - int KEY_LALT
  7543. - int KEY_LCTRL
  7544. - int KEY_LEFT
  7545. - int KEY_LGUI
  7546. - int KEY_LSHIFT
  7547. - int KEY_M
  7548. - int KEY_N
  7549. - int KEY_NUMLOCKCLEAR
  7550. - int KEY_O
  7551. - int KEY_P
  7552. - int KEY_PAGEDOWN
  7553. - int KEY_PAGEUP
  7554. - int KEY_PAUSE
  7555. - int KEY_PRINTSCREEN
  7556. - int KEY_Q
  7557. - int KEY_R
  7558. - int KEY_RALT
  7559. - int KEY_RCTRL
  7560. - int KEY_RETURN
  7561. - int KEY_RETURN2
  7562. - int KEY_RGUI
  7563. - int KEY_RIGHT
  7564. - int KEY_RSHIFT
  7565. - int KEY_S
  7566. - int KEY_SCROLLLOCK
  7567. - int KEY_SELECT
  7568. - int KEY_SHIFT
  7569. - int KEY_SPACE
  7570. - int KEY_T
  7571. - int KEY_TAB
  7572. - int KEY_U
  7573. - int KEY_UNKNOWN
  7574. - int KEY_UP
  7575. - int KEY_V
  7576. - int KEY_W
  7577. - int KEY_X
  7578. - int KEY_Y
  7579. - int KEY_Z
  7580. - unsigned LAST_LOCAL_ID
  7581. - unsigned LAST_REPLICATED_ID
  7582. - int LOG_DEBUG
  7583. - int LOG_ERROR
  7584. - int LOG_INFO
  7585. - int LOG_NONE
  7586. - int LOG_WARNING
  7587. - unsigned MASK_BLENDINDICES
  7588. - unsigned MASK_BLENDWEIGHTS
  7589. - unsigned MASK_COLOR
  7590. - unsigned MASK_CUBETEXCOORD1
  7591. - unsigned MASK_CUBETEXCOORD2
  7592. - unsigned MASK_INSTANCEMATRIX1
  7593. - unsigned MASK_INSTANCEMATRIX2
  7594. - unsigned MASK_INSTANCEMATRIX3
  7595. - unsigned MASK_NONE
  7596. - unsigned MASK_NORMAL
  7597. - unsigned MASK_OBJECTINDEX
  7598. - unsigned MASK_POSITION
  7599. - unsigned MASK_TANGENT
  7600. - unsigned MASK_TEXCOORD1
  7601. - unsigned MASK_TEXCOORD2
  7602. - int MAX_VERTEX_LIGHTS
  7603. - int MOUSEB_LEFT
  7604. - int MOUSEB_MIDDLE
  7605. - int MOUSEB_RIGHT
  7606. - float M_DEGTORAD
  7607. - float M_DEGTORAD_2
  7608. - float M_EPSILON
  7609. - float M_HALF_PI
  7610. - float M_INFINITY
  7611. - float M_LARGE_EPSILON
  7612. - float M_LARGE_VALUE
  7613. - float M_MAX_FOV
  7614. - int M_MAX_INT
  7615. - unsigned M_MAX_UNSIGNED
  7616. - int M_MIN_INT
  7617. - float M_MIN_NEARCLIP
  7618. - unsigned M_MIN_UNSIGNED
  7619. - float M_PI
  7620. - float M_RADTODEG
  7621. - unsigned NUM_FRUSTUM_PLANES
  7622. - unsigned NUM_FRUSTUM_VERTICES
  7623. - float PIXEL_SIZE
  7624. - int QUALITY_HIGH
  7625. - int QUALITY_LOW
  7626. - int QUALITY_MAX
  7627. - int QUALITY_MEDIUM
  7628. - int QUAL_ALT
  7629. - int QUAL_ANY
  7630. - int QUAL_CTRL
  7631. - int QUAL_SHIFT
  7632. - int SCANCODE_0
  7633. - int SCANCODE_1
  7634. - int SCANCODE_2
  7635. - int SCANCODE_3
  7636. - int SCANCODE_4
  7637. - int SCANCODE_5
  7638. - int SCANCODE_6
  7639. - int SCANCODE_7
  7640. - int SCANCODE_8
  7641. - int SCANCODE_9
  7642. - int SCANCODE_A
  7643. - int SCANCODE_AC_BACK
  7644. - int SCANCODE_AC_BOOKMARKS
  7645. - int SCANCODE_AC_FORWARD
  7646. - int SCANCODE_AC_HOME
  7647. - int SCANCODE_AC_REFRESH
  7648. - int SCANCODE_AC_SEARCH
  7649. - int SCANCODE_AC_STOP
  7650. - int SCANCODE_AGAIN
  7651. - int SCANCODE_ALT
  7652. - int SCANCODE_ALTERASE
  7653. - int SCANCODE_APOSTROPHE
  7654. - int SCANCODE_APP1
  7655. - int SCANCODE_APP2
  7656. - int SCANCODE_APPLICATION
  7657. - int SCANCODE_AUDIOMUTE
  7658. - int SCANCODE_AUDIONEXT
  7659. - int SCANCODE_AUDIOPLAY
  7660. - int SCANCODE_AUDIOPREV
  7661. - int SCANCODE_AUDIOSTOP
  7662. - int SCANCODE_B
  7663. - int SCANCODE_BACKSLASH
  7664. - int SCANCODE_BACKSPACE
  7665. - int SCANCODE_BRIGHTNESSDOWN
  7666. - int SCANCODE_BRIGHTNESSUP
  7667. - int SCANCODE_C
  7668. - int SCANCODE_CALCULATOR
  7669. - int SCANCODE_CANCEL
  7670. - int SCANCODE_CAPSLOCK
  7671. - int SCANCODE_CLEAR
  7672. - int SCANCODE_CLEARAGAIN
  7673. - int SCANCODE_COMMA
  7674. - int SCANCODE_COMPUTER
  7675. - int SCANCODE_COPY
  7676. - int SCANCODE_CRSEL
  7677. - int SCANCODE_CTRL
  7678. - int SCANCODE_CURRENCYSUBUNIT
  7679. - int SCANCODE_CURRENCYUNIT
  7680. - int SCANCODE_CUT
  7681. - int SCANCODE_D
  7682. - int SCANCODE_DECIMALSEPARATOR
  7683. - int SCANCODE_DELETE
  7684. - int SCANCODE_DISPLAYSWITCH
  7685. - int SCANCODE_DOWN
  7686. - int SCANCODE_E
  7687. - int SCANCODE_EJECT
  7688. - int SCANCODE_END
  7689. - int SCANCODE_EQUALS
  7690. - int SCANCODE_ESCAPE
  7691. - int SCANCODE_EXECUTE
  7692. - int SCANCODE_EXSEL
  7693. - int SCANCODE_F
  7694. - int SCANCODE_F1
  7695. - int SCANCODE_F10
  7696. - int SCANCODE_F11
  7697. - int SCANCODE_F12
  7698. - int SCANCODE_F13
  7699. - int SCANCODE_F14
  7700. - int SCANCODE_F15
  7701. - int SCANCODE_F16
  7702. - int SCANCODE_F17
  7703. - int SCANCODE_F18
  7704. - int SCANCODE_F19
  7705. - int SCANCODE_F2
  7706. - int SCANCODE_F20
  7707. - int SCANCODE_F21
  7708. - int SCANCODE_F22
  7709. - int SCANCODE_F23
  7710. - int SCANCODE_F24
  7711. - int SCANCODE_F3
  7712. - int SCANCODE_F4
  7713. - int SCANCODE_F5
  7714. - int SCANCODE_F6
  7715. - int SCANCODE_F7
  7716. - int SCANCODE_F8
  7717. - int SCANCODE_F9
  7718. - int SCANCODE_FIND
  7719. - int SCANCODE_G
  7720. - int SCANCODE_GRAVE
  7721. - int SCANCODE_GUI
  7722. - int SCANCODE_H
  7723. - int SCANCODE_HELP
  7724. - int SCANCODE_HOME
  7725. - int SCANCODE_I
  7726. - int SCANCODE_INSERT
  7727. - int SCANCODE_INTERNATIONAL1
  7728. - int SCANCODE_INTERNATIONAL2
  7729. - int SCANCODE_INTERNATIONAL3
  7730. - int SCANCODE_INTERNATIONAL4
  7731. - int SCANCODE_INTERNATIONAL5
  7732. - int SCANCODE_INTERNATIONAL6
  7733. - int SCANCODE_INTERNATIONAL7
  7734. - int SCANCODE_INTERNATIONAL8
  7735. - int SCANCODE_INTERNATIONAL9
  7736. - int SCANCODE_J
  7737. - int SCANCODE_K
  7738. - int SCANCODE_KBDILLUMDOWN
  7739. - int SCANCODE_KBDILLUMTOGGLE
  7740. - int SCANCODE_KBDILLUMUP
  7741. - int SCANCODE_KP_0
  7742. - int SCANCODE_KP_00
  7743. - int SCANCODE_KP_000
  7744. - int SCANCODE_KP_1
  7745. - int SCANCODE_KP_2
  7746. - int SCANCODE_KP_3
  7747. - int SCANCODE_KP_4
  7748. - int SCANCODE_KP_5
  7749. - int SCANCODE_KP_6
  7750. - int SCANCODE_KP_7
  7751. - int SCANCODE_KP_8
  7752. - int SCANCODE_KP_9
  7753. - int SCANCODE_KP_A
  7754. - int SCANCODE_KP_AMPERSAND
  7755. - int SCANCODE_KP_AT
  7756. - int SCANCODE_KP_B
  7757. - int SCANCODE_KP_BACKSPACE
  7758. - int SCANCODE_KP_BINARY
  7759. - int SCANCODE_KP_C
  7760. - int SCANCODE_KP_CLEAR
  7761. - int SCANCODE_KP_CLEARENTRY
  7762. - int SCANCODE_KP_COLON
  7763. - int SCANCODE_KP_COMMA
  7764. - int SCANCODE_KP_D
  7765. - int SCANCODE_KP_DBLAMPERSAND
  7766. - int SCANCODE_KP_DBLVERTICALBAR
  7767. - int SCANCODE_KP_DECIMAL
  7768. - int SCANCODE_KP_DIVIDE
  7769. - int SCANCODE_KP_E
  7770. - int SCANCODE_KP_ENTER
  7771. - int SCANCODE_KP_EQUALS
  7772. - int SCANCODE_KP_EQUALSAS400
  7773. - int SCANCODE_KP_EXCLAM
  7774. - int SCANCODE_KP_F
  7775. - int SCANCODE_KP_GREATER
  7776. - int SCANCODE_KP_HASH
  7777. - int SCANCODE_KP_HEXADECIMAL
  7778. - int SCANCODE_KP_LEFTBRACE
  7779. - int SCANCODE_KP_LEFTPAREN
  7780. - int SCANCODE_KP_LESS
  7781. - int SCANCODE_KP_MEMADD
  7782. - int SCANCODE_KP_MEMCLEAR
  7783. - int SCANCODE_KP_MEMDIVIDE
  7784. - int SCANCODE_KP_MEMMULTIPLY
  7785. - int SCANCODE_KP_MEMRECALL
  7786. - int SCANCODE_KP_MEMSTORE
  7787. - int SCANCODE_KP_MEMSUBTRACT
  7788. - int SCANCODE_KP_MINUS
  7789. - int SCANCODE_KP_MULTIPLY
  7790. - int SCANCODE_KP_OCTAL
  7791. - int SCANCODE_KP_PERCENT
  7792. - int SCANCODE_KP_PERIOD
  7793. - int SCANCODE_KP_PLUS
  7794. - int SCANCODE_KP_PLUSMINUS
  7795. - int SCANCODE_KP_POWER
  7796. - int SCANCODE_KP_RIGHTBRACE
  7797. - int SCANCODE_KP_RIGHTPAREN
  7798. - int SCANCODE_KP_SPACE
  7799. - int SCANCODE_KP_TAB
  7800. - int SCANCODE_KP_VERTICALBAR
  7801. - int SCANCODE_KP_XOR
  7802. - int SCANCODE_L
  7803. - int SCANCODE_LALT
  7804. - int SCANCODE_LANG1
  7805. - int SCANCODE_LANG2
  7806. - int SCANCODE_LANG3
  7807. - int SCANCODE_LANG4
  7808. - int SCANCODE_LANG5
  7809. - int SCANCODE_LANG6
  7810. - int SCANCODE_LANG7
  7811. - int SCANCODE_LANG8
  7812. - int SCANCODE_LANG9
  7813. - int SCANCODE_LCTRL
  7814. - int SCANCODE_LEFT
  7815. - int SCANCODE_LEFTBRACKET
  7816. - int SCANCODE_LGUI
  7817. - int SCANCODE_LSHIFT
  7818. - int SCANCODE_M
  7819. - int SCANCODE_MAIL
  7820. - int SCANCODE_MEDIASELECT
  7821. - int SCANCODE_MENU
  7822. - int SCANCODE_MINUS
  7823. - int SCANCODE_MODE
  7824. - int SCANCODE_MUTE
  7825. - int SCANCODE_N
  7826. - int SCANCODE_NONUSBACKSLASH
  7827. - int SCANCODE_NONUSHASH
  7828. - int SCANCODE_NUMLOCKCLEAR
  7829. - int SCANCODE_O
  7830. - int SCANCODE_OPER
  7831. - int SCANCODE_OUT
  7832. - int SCANCODE_P
  7833. - int SCANCODE_PAGEDOWN
  7834. - int SCANCODE_PAGEUP
  7835. - int SCANCODE_PASTE
  7836. - int SCANCODE_PAUSE
  7837. - int SCANCODE_PERIOD
  7838. - int SCANCODE_POWER
  7839. - int SCANCODE_PRINTSCREEN
  7840. - int SCANCODE_PRIOR
  7841. - int SCANCODE_Q
  7842. - int SCANCODE_R
  7843. - int SCANCODE_RALT
  7844. - int SCANCODE_RCTRL
  7845. - int SCANCODE_RETURN
  7846. - int SCANCODE_RETURN2
  7847. - int SCANCODE_RGUI
  7848. - int SCANCODE_RIGHT
  7849. - int SCANCODE_RIGHTBRACKET
  7850. - int SCANCODE_RSHIFT
  7851. - int SCANCODE_S
  7852. - int SCANCODE_SCROLLLOCK
  7853. - int SCANCODE_SELECT
  7854. - int SCANCODE_SEMICOLON
  7855. - int SCANCODE_SEPARATOR
  7856. - int SCANCODE_SHIFT
  7857. - int SCANCODE_SLASH
  7858. - int SCANCODE_SLEEP
  7859. - int SCANCODE_SPACE
  7860. - int SCANCODE_STOP
  7861. - int SCANCODE_SYSREQ
  7862. - int SCANCODE_T
  7863. - int SCANCODE_TAB
  7864. - int SCANCODE_THOUSANDSSEPARATOR
  7865. - int SCANCODE_U
  7866. - int SCANCODE_UNDO
  7867. - int SCANCODE_UNKNOWN
  7868. - int SCANCODE_UP
  7869. - int SCANCODE_V
  7870. - int SCANCODE_VOLUMEDOWN
  7871. - int SCANCODE_VOLUMEUP
  7872. - int SCANCODE_W
  7873. - int SCANCODE_WWW
  7874. - int SCANCODE_X
  7875. - int SCANCODE_Y
  7876. - int SCANCODE_Z
  7877. - unsigned SCAN_DIRS
  7878. - unsigned SCAN_FILES
  7879. - unsigned SCAN_HIDDEN
  7880. - String SOUND_AMBIENT
  7881. - String SOUND_EFFECT
  7882. - String SOUND_MASTER
  7883. - String SOUND_MUSIC
  7884. - String SOUND_VOICE
  7885. - unsigned VO_DISABLE_OCCLUSION
  7886. - unsigned VO_DISABLE_SHADOWS
  7887. - unsigned VO_LOW_MATERIAL_QUALITY
  7888. - unsigned VO_NONE
  7889. */
  7890. }