LuaScriptAPI.dox 240 KB

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