LuaScriptAPI.dox 231 KB

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