LuaScriptAPI.dox 268 KB

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