LuaScriptAPI.dox 247 KB

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