LuaScriptAPI.dox 256 KB

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