LuaScriptAPI.dox 268 KB

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