LuaScriptAPI.dox 257 KB

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