LuaScriptAPI.dox 236 KB

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