LuaScriptAPI.dox 236 KB

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