LuaScriptAPI.dox 232 KB

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