LuaScriptAPI.dox 230 KB

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