LuaScriptAPI.dox 241 KB

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