The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

Difference between revisions of "UE2:CrosshairPack (UT2004)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Auto-generated page)
 
(added descriptions and linked to my custom crosshair pack template project)
 
Line 4: Line 4:
 
| abstract = yes
 
| abstract = yes
 
}}
 
}}
{{autogenerated}}
+
Base class for custom crosshair texture packs.
Meta class for custom crosshair texture packs
+
In order for your custom crosshair texture packages to appear in the game, you must
+
export the crosshairs to cache files, using the 'exportcache' commandlet.
+
  
For details on using the 'exportcache' commandlet, see Engine.Mutator or type
+
In order for your custom crosshair texture packages to appear in the game, you must export the crosshairs to cache files. This happens automatically when you compile the CrosshairPack subclass, but can also be done manually using the 'exportcache' commandlet. Textures for custom crosshair packs should reside in a separate texture package so players don't get into trouble because they loaded an unknown class, the custom CrosshairPack subclass. The general idea of this class is to automatically create cache file entries at compile-time, it isn't actually used or even loaded at runtime.
'ucc help exportcache' at the command prompt.
+
 
+
Created by Ron Prestenback
+
© 2003, Epic Games, Inc. All Rights Reserved
+
  
 
==Properties==
 
==Properties==
Line 22: Line 15:
 
'''[[Variables#Modifiers|Modifiers]]:''' const, protected, cache
 
'''[[Variables#Modifiers|Modifiers]]:''' const, protected, cache
  
<!-- enter variable description -->
+
The list of crosshairs in the crosshair pack. These will be exported to a [[cache file]] (.UCL) when compiling the package or running the {{cl|ExportCacheCommandlet}}.
  
 
==Structs==
 
==Structs==
Line 28: Line 21:
 
'''[[Structs#Modifiers|Modifiers]]:''' native
 
'''[[Structs#Modifiers|Modifiers]]:''' native
  
<!-- enter struct description -->
+
Holds the texture reference and the display name of a crosshair.
; [[string]] FriendlyName : Name of crosshair, as it will appear in drop-down list
+
; [[string]] FriendlyName : The name of a crosshair which will be displayed in the drop-down list of crosshairs.
; {{cl|Texture}} CrosshairTexture : <!-- enter variable description -->
+
; {{cl|Texture}} CrosshairTexture : The texture used for the crosshair. Note that you can only use Texture materials, no material modifiers.
 +
 
 +
==See also==
 +
* [http://www.koehler-homepage.de/Wormbo/unrealwiki.html#CP Crosshair pack example] - a template project by [[User:Wormbo|Wormbo]] for custom UT2004 crosshair packs

Latest revision as of 12:34, 15 December 2008

UT2004 Object >> CrosshairPack
Package: 
Engine
Direct subclasses:
DefaultCrosshairs, ONSCrosshairs

Base class for custom crosshair texture packs.

In order for your custom crosshair texture packages to appear in the game, you must export the crosshairs to cache files. This happens automatically when you compile the CrosshairPack subclass, but can also be done manually using the 'exportcache' commandlet. Textures for custom crosshair packs should reside in a separate texture package so players don't get into trouble because they loaded an unknown class, the custom CrosshairPack subclass. The general idea of this class is to automatically create cache file entries at compile-time, it isn't actually used or even loaded at runtime.

Properties[edit]

Property group 'CrosshairPack'[edit]

Crosshair[edit]

Type: array<CrosshairItem>

Modifiers: const, protected, cache

The list of crosshairs in the crosshair pack. These will be exported to a cache file (.UCL) when compiling the package or running the ExportCacheCommandlet.

Structs[edit]

CrosshairItem[edit]

Modifiers: native

Holds the texture reference and the display name of a crosshair.

string FriendlyName 
The name of a crosshair which will be displayed in the drop-down list of crosshairs.
Texture CrosshairTexture 
The texture used for the crosshair. Note that you can only use Texture materials, no material modifiers.

See also[edit]