LuaScriptAPI.dox 262 KB

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