LuaScriptAPI.dox 275 KB

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