0% found this document useful (0 votes)
10 viewsCreatingNativeClasses
The document provides an overview of Unreal Engine 3's native class generation, focusing on C++ code and the use of autogenerated headers for easier integration with UnrealScript. It discusses the implementation of native functions, class declarations, and the interaction with the UnrealScript VM, emphasizing the importance of proper parameter handling and event triggering. Additionally, it outlines the setup for native-only classes and the necessary macros for registration within the engine.
Uploaded by
Alan AlvaradoCopyright
© © All Rights Reserved
Available Formats
Download as PDF or read online on Scribd
0% found this document useful (0 votes)
10 viewsCreatingNativeClasses
The document provides an overview of Unreal Engine 3's native class generation, focusing on C++ code and the use of autogenerated headers for easier integration with UnrealScript. It discusses the implementation of native functions, class declarations, and the interaction with the UnrealScript VM, emphasizing the importance of proper parameter handling and event triggering. Additionally, it outlines the setup for native-only classes and the necessary macros for registration within the engine.
Uploaded by
Alan AlvaradoCopyright
© © All Rights Reserved
Available Formats
Download as PDF or read online on Scribd
/ 5
Garber
+ suoenerted Hers
© Uneaten vi svsracton
+ Manual enschede
© Uneaten vi ration
ate tnctonparamatars
Naive uncon tun vals
+ Tooataa avons
© Matte is ingiementtion
© PacisoescoptRenstsion
+ Nate cass
+ Example Cose Domina
Overview
Ts document covers the eration of classe Unrsl Engine 3 which contain C+ cde; pomarly Unrealeent clases inked fo C-~
abv package setup i cover te separte ole Crezng Natve Pactazes. See Nebve Cong Abvance Overview and Natve cap! Tepes in Engne Programming tor
moe nate coding tps.
Thar are tes gaeralvanatone of ratve dassoe
+. Unvatsep vin euagenerstednesders
2 Uneaenp! winout autgenarstaanessere
Conon asses
Autogenerated Headers
‘Tne preter way tine nave cose wih UnesiSnp it use aunganerstea meade, a Ms wy he Sept comple automa kagps he esters up ted
‘The flbuing code, tom the laches AutoGenExample package, sows the most asc nav lass exempt
hass t 0b) extends onject
‘ative fine function bool ExnplelativeFunction(iat A);
fee bod anette «)
“aos(-Exanpretvent 6A):
?
Sms impran aepects ofthis dass, relating to nate coding
+ ati ass koyword Coming ater ‘atends Otero rave keyword spaces that Ms as cota nate (C++) co40
{+ native funn kevord nan stureton ceed wth te nv space, that aan tw be mpleeniedn C+=. men a nae uncon calle re
Uneslsnot a eats cess tcne C- lemantaton. beers retunma ose,
+ event finan keyed Functane wth the een spect ae fans imemenadin UneaScin, ut whch canbe called rom C-~ Wah sfogeneratd headers, =
(Cos uncon sven sexpoted umere™ te uncon name) a eatg he Spt uncon
Native Class Declaration
len comple he srt comple wil automatcaly generate and ouout vo es AuteGenExampenc
+ AutoGonexamplecasses.n Tic mathe nate es Gecaraton, wh aol of sv9PerIng Code a nate ineazaton and ronan king fo UnaasSrtdaseHs
+ AutoGenCxampleNomes Name decaations exported tom Uns,
The dass deiaaton in auloGenxampleClasse nooks he so
oes SE 0 sentEnuatret Pare as wotog + etc vnsect
PY fen acc mors 08 003
ESAS
een
ee
peer antes);
reemaste
5th et tthi-scvareat ef incton)
foo. cventteretven 8)
AcE ob eventrnolefvent Pans Parn(EC_Eventara)
iets tn(pdfantionCheched(ATOGRIEMOLE Expert), Parse)
yr
Excuse css (wast on unojece 9, scrocencxaepe)
>, DEOL ona OE oh
NOTE: Inthe UnealStigt cies detnen you can optonaly sey en ExportName parameter rhe Css nave keyword inthe oma naWe(ExporNeme ke so
(ass, AGEon} extends Obdect
‘netiua{tent)s
‘Tis wit expat ne las to AutoGenExampeTestClasses.n, her nen AuloGerExempleCassesh
‘Suecisse5 il not automaticaly excor to AudoGenExampeTestCsss65.: you iho do ths, pect the special hyve inherits, e¢.nabetnhents.
Unrealscript VM abstraction
utogeneeted nedersastectauay ast aspect of inking C++ sre UnesScipt cose, aking development and malnanance easier,
Have a uncon axe epee nto ete UnveaiSc VA
oot Exons ttveFunctlon (INT A);
ech Fkc HonCesecesanpLetativetanction)
‘ubbot“inesutt~tnis-rexanptetativerunction(A);
‘men BxompleatveF unten scaled Urea, tages Ns unetion. Ths handles parsing o parameters Nam veer, passes ono the C++
ExamplaetueFunctontmeton (5 stovn by this->ExampleAmtiveFumetin(A)) 800 sends re retu vue Back Sng
‘tachescerganeraton ln needs tobe inlemented manvady le the ExampleNatf uneton etn
’ conjesbxamplenativerunction( IN A)
fete eenempesent(
se same tan wih UrealSco evens, asogeerted eae pone you uh 2 uncon tah il rset.
tts evntaapetvnt MT 4
4a one Pres Parl rear
FroceintventFinarunction cee ALTOGENOGPELE,fsamplecvent) APS);
Retiro eters?
“vere nate runetns ae coed rom Unreal and pe passed to C-~ events are he opposite hey te calles Hom ++ and ar pase to Uneeisur
Native Class Implementation
“The ony oer im ing to moment in he.co Ml i he MPLEMENT_CLASS macro, once for eas sive caES eg.
{WPLENENT_cLASS(UACE 001)
Manually defined headers ‘lone 2071, You stud avo ing woesna arava csi
Most nstonaty for noexor asses canbe replaces win copkesinsteed.
NOTE: See me stasis ManualHeaderExampl pj 10 Sea ul implementation a2 nave package wih manualy dened Noadrs.
Income cieactensae, lowe nat caso at ae mosty C=», ana vic rly ova nave tot UneaiScl code uedatod, makes mor sans fo manwaly
Iansn readers fr ne es Typcty thse sre is prose some bes varicie-acassto see ajte = ave neon oro) and nave he qu of he nctenay
Implemented andhiddn aay in Co.
lit nese asses, you mut mantaly mtn Bary compatabty bstneen the Unealrt ard C++ dents ofthe clas, and native functions dont automatically hance
Uneaserot YM abstraction
In Uraacr, the priarydneance wen manually goeraoateadars & te addin of he nogxport G3es TMi the Compl Noto ete suoganetes Heads fox
‘ne tlouing code enone a asic seme ot @noeipet an:
‘caass, mon} extends ondect
eexpect
‘tive Final fonction bool EsaplalativeFunction(int 8);
Fro ool Eametventtint 4)
og trangLetent:"@8);
Native Class Declaration
mete sutgeneratednesdes e.mail spt et a “Cassese fr yourpckagecontanng a nave cles deiatetons, you Intend need to manuady dere eae
nave iss that uses the neeszot fag,
The ass delaraton or MHE_O6 ook he so:
se UME 065 + ie ect
DECLARE CLASS NOEXPORT (UE Co, UObIect,
‘LDerAULT CONSTRUCTOR UH
rciae_FuNCTION(execteampletaesverunetion
aquelitenderExample)5
»
‘Snce MHE_Cojn Uneacrpt tends Object same btu me naNe code; you nav SES UMINE_O8:pubte VOD
‘Tne DECLARE_CLASS macs are cEsantal fr provery nang rab lass65 Wh he Erg, End ns ce, DECLARE_CLASS_NOEKPORT used, since NHE_O0)
uso the noob as
‘Tha maze NO_DEFAULT_CONSTRUCTOR jst mplomers 3 protected deautconetucer fr he dss you tke, you san mplarent your own constr, Ke You
would any ener cas.
For evry atv uct Getned in the UnvetStrp lass, he DECLARE_FUNCTION gro mus be used decane nerve code prepencing EXE 0 exe) nave
‘unten name, 2.
‘tive Final function boot Exmaplaiverunction (iat 8);
Becomes:
DECLARE FUNCTIONCexecExzapLeatveFunctlon);
Note ne comarca automat headers for AutoGanexarola,xacExamplastveF uncon coser aa &predetnes boo) to automatealy pase paramates pacsag
on to"ExamploaveFuncten, and ‘evntSxarpleEvent nt donee
Bot others nave obs soup manual nts, 2c heros no aura abstraction fom the UnreaScrpt VM wth manual deine heads.
‘See Nats Catina Atvanced Qvenie fr mere informaton on these actos, ther parameters anda dniton
UnrealScript VM interaction
Incrder to enpement‘execExamoleNabveF unto jou need tinct itmore closely wih the UreaScret VAL moe spectcaly his means interacting cect wth the
es stack ere he cot executen sae, ca variates. ane uncten parameter ored.
“Tak thse e369 han Sounds and haw 379 cx To doig dered in UnScrptMacros.n; ane a a ase cer ac gos, wo ro only Iarste in gttng
‘me nave neon pramates, and setng te eum value
Native tunction parameters NOTE: atv taetons atnaract th he UneaScnptVM ae sind wih he tmp
ee (FFamo® Stack, RESULT_DECL (tn bingo fancion rm)
For‘eocEampltaveFuncto’ the impomenaton eae Wo ths
pots wos: cerectraaplattvetuc tion Franek Stack, RESULT BCL)
eT MTR:
Hore te macro P_GET.INT pul th’ paramator rm he stack thre smote han one patamelr onthe stack its eseniapultham on fhe caret oder
‘The P_FINISH macs spacial macro that must be used in ayn nate funcin tir grabbing te parameters (ral cla of function fhe are ro params)
ero pope aavance the scp sack
Iryeuomt P_FINISH:caling ne neve uncon wl cna te re tek aerate game
‘See ule Cotng Advanced Oven fr he st of hese macros,
[ts vey import at te nave function parameters in Lets, math te parameters piled Of he stack n Cee, heise cage nine facon wl oruptine
Stee, causing te game to crash
Tei another advantago of etocenerato headers over manually dofnedheadas, nce autgonerisd header hands pullng paramere of he sack, you never hav io
way about mésmetnes parameters
Native function return values
For nave functns wih art vo,
