BrawlCrate v0.41
Wii File Editor
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Properties | List of all members
BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode Class Reference
Inheritance diagram for BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode:
BrawlLib.SSBB.ResourceNodes.ResourceNode

Public Types

enum  StageFlags : ushort
 
enum  VariantType : byte
 

Public Member Functions

override void OnPopulate ()
 
override bool OnInitialize ()
 
override int OnCalculateSize (bool force)
 
override void OnRebuild (VoidPtr address, int length, bool force)
 
- Public Member Functions inherited from BrawlLib.SSBB.ResourceNodes.ResourceNode
void OnRenamed ()
 
List< ResourceNodeGetChildrenRecursive ()
 Used primarily to get bone lists. Kept for all resource nodes for utility. More...
 
virtual void SignalPropertyChange ()
 
virtual void Dispose ()
 
void SelectChildAtIndex (int index)
 
void UpdateProperties ()
 
void UpdateCurrentControl ()
 
virtual bool MoveUp ()
 
virtual bool MoveDown ()
 
virtual void OnMoved ()
 
virtual void DoMoveDown ()
 
virtual void DoMoveDown (bool select)
 
virtual void DoMoveUp ()
 
virtual void DoMoveUp (bool select)
 
virtual bool AddUp ()
 
virtual bool AddDown ()
 
virtual bool ToParent ()
 
void Populate (int levels=-1)
 
virtual void OnPopulate ()
 
void Initialize (ResourceNode parent, FileMap source)
 
void Initialize (ResourceNode parent, VoidPtr address, int length)
 
void Initialize (ResourceNode parent, DataSource origSource)
 
virtual void Initialize (ResourceNode parent, DataSource origSource, DataSource uncompSource)
 
virtual bool OnInitialize ()
 
virtual void Restore ()
 
virtual void Remove ()
 
virtual void RemoveChild (ResourceNode child)
 
virtual void AddChild (ResourceNode child)
 
virtual void AddChild (ResourceNode child, bool change)
 
virtual void InsertChild (ResourceNode child, int index)
 
virtual void InsertChild (ResourceNode child, bool change, int index)
 
void SetSizeInternal (int size)
 
virtual void Replace (string fileName)
 
virtual void Replace (ResourceNode node)
 
virtual void Replace (string fileName, FileMapProtect prot, FileOptions options)
 
virtual void ReplaceRaw (VoidPtr address, int length)
 
virtual void ReplaceRaw (FileMap map)
 
virtual void Export (string outPath)
 
void Export (FileStream outStream)
 
virtual void ExportUncompressed (string outPath)
 
void ExportUncompressed (FileStream outStream)
 
virtual void Rebuild ()
 
virtual void Rebuild (bool force)
 
virtual void Rebuild (VoidPtr address, int length, bool force)
 
virtual void OnRebuild (VoidPtr address, int length, bool force)
 
virtual int CalculateSize (bool force)
 
virtual int OnCalculateSize (bool force)
 
void Merge ()
 
void Merge (bool forceBuild)
 
ResourceNode FindChildByType (string path, bool searchChildren, params ResourceType[] types)
 
ResourceNode FindChildByType (string path, bool searchChildren, StringComparison compare, params ResourceType[] types)
 
ResourceNode FindChild (string path)
 
ResourceNode FindChild (string path, bool searchChildren)
 
ResourceNode FindChild (string path, StringComparison compare)
 
ResourceNode FindChild (string path, bool searchChildren, StringComparison compare)
 
ResourceNode[] FindChildrenByClassType (string path, Type type)
 
ResourceNode[] FindChildrenByType (string path, ResourceType type)
 
ResourceNode[] FindChildrenByTypeInGroup (string path, ResourceType type, byte group)
 
ResourceNode[] FindChildrenByName (string name)
 
unsafe string FindName (string name)
 
ResourceNode FindEmbeddedIndex (int index)
 
virtual unsafe byte[] MD5 ()
 Find the MD5 checksum of this node's data. If this node doesn't have any data (BRESGroupNode, for example), this method will return null. More...
 
string MD5Str ()
 Get the result of the MD5() function as a string of hexadecimal digits. If MD5() returns null, this method will return an empty string. More...
 
ResourceNode PrevSibling ()
 
ResourceNode NextSibling ()
 
override string ToString ()
 
virtual void SortChildren ()
 

Properties

override ResourceType ResourceFileType [get]
 
override bool AllowDuplicateNames [get]
 
override Type[] AllowedChildTypes [get]
 
string StageName [get, set]
 
string TrackList [get, set]
 
string Module [get, set]
 
RGBAPixel CharacterOverlay [get, set]
 
ushort SoundBank [get, set]
 
ushort EffectBank [get, set]
 
StageFlags Flags [get, set]
 
bool IsFlat [get, set]
 
bool IsFixedCamera [get, set]
 
bool IsSlowStart [get, set]
 
bool IsDualLoad [get, set]
 
bool IsDualShuffle [get, set]
 
bool IsOldSubstage [get, set]
 
VariantType SubstageVarianceType [get, set]
 
byte SubstageRange [get, set]
 
uint MemoryAllocation [get, set]
 
float WildSpeed [get, set]
 
- Properties inherited from BrawlLib.SSBB.ResourceNodes.ResourceNode
string FilePath [get]
 
string FileName [get]
 
string DirectoryName [get]
 
ResourceNode RootNode [get]
 
DataSource OriginalSource [get]
 
DataSource UncompressedSource [get]
 
DataSource WorkingSource [get]
 
DataSource WorkingUncompressed [get]
 
virtual bool HasChildren [get]
 
virtual ResourceType ResourceFileType [get]
 
string NodeType [get]
 
virtual string TreePathAbsolute [get]
 
virtual string TreePath [get]
 
virtual int Level [get]
 
virtual int MaxNameLength [get]
 
virtual bool AllowDuplicateNames [get]
 
virtual bool AllowNullNames [get]
 
virtual string Name [get, set]
 
ResourceNode Parent [get, set]
 
List< ResourceNodeChildren [get]
 
int Index [get]
 
int HexIndex [get]
 
bool IsCompressed [get]
 
bool HasChanged [get, set]
 
bool IsBranch [get]
 
bool HasMerged [get]
 
virtual bool AllowSaving [get, set]
 
virtual bool IsDirty [get, set]
 
virtual uint UncompressedSize [get]
 
virtual Type[] AllowedChildTypes [get]
 
virtual string Compression [get, set]
 
virtual bool RetainChildrenOnReplace [get]
 
virtual bool supportsCompression [get]
 
static MD5CryptoServiceProvider MD5Provider [get]
 

Additional Inherited Members

- Static Public Member Functions inherited from BrawlLib.SSBB.ResourceNodes.ResourceNode
static ResourceNode[] FindAllSubNodes (ResourceNode root)
 
static ResourceNode FindNode (ResourceNode root, string path, bool searchChildren, StringComparison compare)
 
- Public Attributes inherited from BrawlLib.SSBB.ResourceNodes.ResourceNode
Form _mainForm
 
string _name
 
string _origPath
 
ResourceNode _parent
 
List< ResourceNode_children = new List<ResourceNode>()
 
int _calcSize
 
EventHandler UpdateControl
 
MoveEventHandler MovedDown
 
ResourceEventHandler Renamed
 
ResourceEventHandler PropertyChanged
 
ResourceEventHandler Replaced
 
ResourceEventHandler Restored
 
ResourceChildEventHandler ChildRemoved
 
bool _isPopulating
 
bool _replaced
 
- Protected Member Functions inherited from BrawlLib.SSBB.ResourceNodes.ResourceNode
void ForceReplacedEvent ()
 
virtual void MergeInternal ()
 
- Events inherited from BrawlLib.SSBB.ResourceNodes.ResourceNode
SelectEventHandler SelectChild
 
EventHandler UpdateProps
 
MoveEventHandler MovedUp
 
ResourceEventHandler Disposing
 
ResourceChildEventHandler ChildAdded
 
ResourceChildInsertEventHandler ChildInserted
 

Member Enumeration Documentation

◆ StageFlags

21 {
22 None = 0x0000,
23 Flat = 0x0001,
24 FixedCamera = 0x0002,
25 SlowStart = 0x0004,
26 DualLoad = 0x0008,
27 DualShuffle = 0x0010,
28 OldSubstage = 0x0020
29 }

◆ VariantType

32 {
33 Normal = 0x00,
34 RandomVariance = 0x01,
35 SequentialTransform = 0x02,
36 RandomTransform = 0x03,
37 TimeBasedVariance = 0x04,
38 None = 0xFF
39 }

Member Function Documentation

◆ OnCalculateSize()

override int BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.OnCalculateSize ( bool  force)
inlinevirtual

Reimplemented from BrawlLib.SSBB.ResourceNodes.ResourceNode.

287 {
288 int size = (int)STEX.HeaderSize;
289
290 size += 4 * Children.Count;
291
292 if (!string.IsNullOrEmpty(StageName))
293 {
294 size += StageName.UTF8Length() + 1;
295 }
296 if (!string.IsNullOrEmpty(TrackList))
297 {
298 size += TrackList.UTF8Length() + 1;
299 }
300 if (!string.IsNullOrEmpty(Module))
301 {
302 size += Module.UTF8Length() + 1;
303 }
304
305 List<string> names = new List<string>();
306 foreach (ResourceNode n in Children)
307 {
308 if (names.Contains(n.Name))
309 {
310 continue;
311 }
312 names.Add(n.Name);
313 size += n.Name.UTF8Length() + 1;
314 }
315
316 return size;
317 }
string Module
Definition: STEXNode.cs:68
string StageName
Definition: STEXNode.cs:44
string TrackList
Definition: STEXNode.cs:56
List< ResourceNode > Children
Definition: ResourceNode.cs:262
static readonly uint HeaderSize
Definition: STEX.cs:9

◆ OnInitialize()

override bool BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.OnInitialize ( )
inlinevirtual

Reimplemented from BrawlLib.SSBB.ResourceNodes.ResourceNode.

266 {
267 if (_name == null && _origPath != null)
268 {
269 _name = Path.GetFileNameWithoutExtension(_origPath);
270 }
271 _stageName = Header->stageName;
272 _trackList = Header->trackListName;
273 _module = Header->moduleName;
274 _rgbaOverlay = (uint)Header->_rgbaOverlay;
275 _soundBank = Header->_soundBank;
276 _effectBank = Header->_effectBank;
277 _flags = (StageFlags)(ushort)Header->_flags;
278 _stageType = Header->_stageType;
279 _subStageRange = Header->_subStageRange;
280 _memoryAllocation = Header->_memoryAllocation;
281 _wildSpeed = Header->_wildSpeed;
282
283 return Header->subStageCount > 0 || Header->_subStageRange > 0;
284 }
string _origPath
Definition: ResourceNode.cs:139
string _name
Definition: ResourceNode.cs:139
buint _memoryAllocation
Definition: STEX.cs:23
bfloat _wildSpeed
Definition: STEX.cs:24
bushort _flags
Definition: STEX.cs:17
buint _rgbaOverlay
Definition: STEX.cs:14
string moduleName
Definition: STEX.cs:53
byte _subStageRange
Definition: STEX.cs:19
byte _stageType
Definition: STEX.cs:18
uint subStageCount
Definition: STEX.cs:28
bushort _soundBank
Definition: STEX.cs:15
string stageName
Definition: STEX.cs:52
string trackListName
Definition: STEX.cs:51
bushort _effectBank
Definition: STEX.cs:16

◆ OnPopulate()

override void BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.OnPopulate ( )
inlinevirtual

Reimplemented from BrawlLib.SSBB.ResourceNodes.ResourceNode.

257 {
258 int i;
259 for (i = 0; i < Header->subStageCount; i++)
260 {
261 new RawDataNode { _name = Header->subStageName(i) }.Initialize(this, null, 0);
262 }
263 }
string subStageName(int index)
Definition: STEX.cs:41

◆ OnRebuild()

override void BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.OnRebuild ( VoidPtr  address,
int  length,
bool  force 
)
inlinevirtual

Reimplemented from BrawlLib.SSBB.ResourceNodes.ResourceNode.

320 {
321 uint strOffset = STEX.HeaderSize + (uint)Children.Count * 4;
322
323 STEX* header = (STEX*)address;
324 *header = new STEX();
325 header->_tag = STEX.Tag;
326 header->_stringOffset = strOffset;
327 header->_size = (uint)length;
328 header->_rgbaOverlay = ((uint)_rgbaOverlay).Reverse();
329 header->_soundBank = _soundBank;
330 header->_effectBank = _effectBank;
331 header->_flags = (ushort)_flags;
332 header->_stageType = _stageType;
333 header->_subStageRange = _subStageRange;
334
335 uint curStrOffset = 0x0;
336 if (!string.IsNullOrEmpty(TrackList))
337 {
338 header->_trackListOffset = curStrOffset;
339 curStrOffset += (uint)TrackList.UTF8Length() + 1;
340 }
341 else
342 {
343 header->_trackListOffset = 0xFFFFFFFF;
344 }
345 if (!string.IsNullOrEmpty(StageName))
346 {
347 header->_stageNameOffset = curStrOffset;
348 curStrOffset += (uint)StageName.UTF8Length() + 1;
349 }
350 else
351 {
352 header->_stageNameOffset = 0xFFFFFFFF;
353 }
354 if (!string.IsNullOrEmpty(Module))
355 {
356 header->_moduleNameOffset = curStrOffset;
357 curStrOffset += (uint)Module.UTF8Length() + 1;
358 }
359 else
360 {
361 header->_moduleNameOffset = 0xFFFFFFFF;
362 }
363 header->_memoryAllocation = _memoryAllocation;
364 header->_wildSpeed = _wildSpeed;
365
366 uint offset = STEX.HeaderSize;
367 Dictionary<string, uint> names = new Dictionary<string, uint>();
368 foreach (ResourceNode n in Children)
369 {
370 buint* ptr = (buint*) (address + offset);
371 offset += 4;
372 if (names.ContainsKey(n.Name))
373 {
374 ptr[0] = names[n.Name];
375 continue;
376 }
377 ptr[0] = curStrOffset;
378 names.Add(n.Name, curStrOffset);
379 curStrOffset += (uint)n.Name.UTF8Length() + 1;
380 }
381
382 if (TrackList?.UTF8Length() > 0)
383 {
384 offset += address.WriteUTF8String(TrackList, true, offset);
385 }
386 if (StageName?.UTF8Length() > 0)
387 {
388 offset += address.WriteUTF8String(StageName, true, offset);
389 }
390 if (Module?.UTF8Length() > 0)
391 {
392 offset += address.WriteUTF8String(Module, true, offset);
393 }
394
395 foreach (var name in names)
396 {
397 offset += address.WriteUTF8String(name.Key, true, offset);
398 }
399 }
uint WriteUTF8String(string s)
Definition: VoidPtr.cs:239
Definition: BigEndianTypes.cs:59
static readonly uint Tag
Definition: STEX.cs:10

Property Documentation

◆ AllowDuplicateNames

override bool BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.AllowDuplicateNames
get

◆ AllowedChildTypes

override Type [] BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.AllowedChildTypes
get

◆ CharacterOverlay

RGBAPixel BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.CharacterOverlay
getset
84 {
85 get => _rgbaOverlay;
86 set
87 {
88 _rgbaOverlay = value;
90 }
91 }
virtual void SignalPropertyChange()
Definition: ResourceNode.cs:313

◆ EffectBank

ushort BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.EffectBank
getset
111 {
112 get => _effectBank;
113 set
114 {
115 _effectBank = value;
117 }
118 }

◆ Flags

StageFlags BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.Flags
getset
125 {
126 get => _flags;
127 set
128 {
129 _flags = value;
131 }
132 }

◆ IsDualLoad

bool BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.IsDualLoad
getset
172 {
173 get => (_flags & StageFlags.DualLoad) != 0;
174 set
175 {
176 _flags = (_flags & ~StageFlags.DualLoad) |
177 (value ? StageFlags.DualLoad : 0);
179 }
180 }

◆ IsDualShuffle

bool BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.IsDualShuffle
getset
184 {
185 get => (_flags & StageFlags.DualShuffle) != 0;
186 set
187 {
188 _flags = (_flags & ~StageFlags.DualShuffle) |
189 (value ? StageFlags.DualShuffle : 0);
191 }
192 }

◆ IsFixedCamera

bool BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.IsFixedCamera
getset
148 {
149 get => (_flags & StageFlags.FixedCamera) != 0;
150 set
151 {
152 _flags = (_flags & ~StageFlags.FixedCamera) |
153 (value ? StageFlags.FixedCamera : 0);
155 }
156 }

◆ IsFlat

bool BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.IsFlat
getset
136 {
137 get => (_flags & StageFlags.Flat) != 0;
138 set
139 {
140 _flags = (_flags & ~StageFlags.Flat) |
141 (value ? StageFlags.Flat : 0);
143 }
144 }

◆ IsOldSubstage

bool BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.IsOldSubstage
getset
196 {
197 get => (_flags & StageFlags.OldSubstage) != 0;
198 set
199 {
200 _flags = (_flags & ~StageFlags.OldSubstage) |
201 (value ? StageFlags.OldSubstage : 0);
203 }
204 }

◆ IsSlowStart

bool BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.IsSlowStart
getset
160 {
161 get => (_flags & StageFlags.SlowStart) != 0;
162 set
163 {
164 _flags = (_flags & ~StageFlags.SlowStart) |
165 (value ? StageFlags.SlowStart : 0);
167 }
168 }

◆ MemoryAllocation

uint BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.MemoryAllocation
getset
234 {
235 get => _memoryAllocation;
236 set
237 {
238 _memoryAllocation = value;
240 }
241 }

◆ Module

string BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.Module
getset
68 {
69 get => _module;
70 set
71 {
72 _module = value.Substring(0, value.Length > 32 ? 32 : value.Length);
73 while (_module.UTF8Length() > 32)
74 {
75 _module = value.Substring(0, _module.Length - 1);
76 }
78 }
79 }

◆ ResourceFileType

override ResourceType BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.ResourceFileType
get

◆ SoundBank

ushort BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.SoundBank
getset
98 {
99 get => _soundBank;
100 set
101 {
102 _soundBank = value;
104 }
105 }

◆ StageName

string BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.StageName
getset
44 {
45 get => _stageName;
46 set
47 {
48 _stageName = value;
50 }
51 }

◆ SubstageRange

byte BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.SubstageRange
getset
221 {
222 get => _subStageRange;
223 set
224 {
225 _subStageRange = value;
227 }
228 }

◆ SubstageVarianceType

VariantType BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.SubstageVarianceType
getset
209 {
210 get => (VariantType)_stageType;
211 set
212 {
213 _stageType = (byte)value;
215 }
216 }

◆ TrackList

string BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.TrackList
getset
56 {
57 get => _trackList;
58 set
59 {
60 _trackList = value;
62 }
63 }

◆ WildSpeed

float BrawlLib.SSBB.ResourceNodes.ProjectPlus.STEXNode.WildSpeed
getset
247 {
248 get => _wildSpeed;
249 set
250 {
251 _wildSpeed = value;
253 }
254 }

The documentation for this class was generated from the following file: