LuaScriptAPI.dox 231 KB

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