Editing Character Swapping Framework Documentation (section)

=== Version 2.0. ===
Released with the release of "Sonic Unleashed: Reimagined update 2.0.0", version 2.0 rewrites the core system from its previous bool flag based version, to now use integer flags. In theory this allows for an endless amount of character slots and flag modifier lists. This also reduces the FlagList occupied flags from 2-8 bool flags to just 1-2 integer flags.

This update also brought with it the ability to switch characters within night stages and the final boss, allowing for Werehog model swapping and Super Sonic model swapping.

==== Replaced: ====
bFlag_isCharacter

bFlag_is{modifiable}

bFlag_is{modifiable}

bFlag_is{modifiable}

bFlag_is{modifiable}

bFlag_is{modifiable}

bFlag_is{modifiable}

bFlag_is{modifiable}

==== With: ====
iFlag_isDayCharacter

iFlag_isNightCharacter

iFlag_isSuperCharacter<syntaxhighlight lang="xml">
      <Flag type="Int">
        <!--リザーブ-->
        <name>iFlag_DayCharacter</name>
      </Flag>
      <Flag type="Int">
        <!--リザーブ-->
        <name>iFlag_NightCharacter</name>
      </Flag>
      <Flag type="Int">
        <!--リザーブ-->
        <name>iFlag_SuperCharacter</name>
      </Flag>
</syntaxhighlight>Below is an example of how the flag modifier script now looks, these can be duplicated infinitely, assuming the "'''FlagValue'''" is unique and referenced in the '''SR_Enter''' scripts.<syntaxhighlight lang="xml">
<MicroSequence>
<Switch>
  <Case flag="eFlag_TownState" operation="E" value="eFlag_TownState_Day">
		<Switch> 
		  <Case flag="iFlag_DayCharacter" operation="GE" value="1">
		    <SequenceUnit>
		      <type>SetFlag</type>
			  <param>
			    <FlagName>iFlag_DayCharacter</FlagName>
			    <FlagValue>0</FlagValue>
			  </param>
		    </SequenceUnit>
		  </Case>
		  <Case flag="iFlag_DayCharacter" operation="E" value="0">
		    <Switch>
			  <Case flag="eFlag_LastTown" operation="E" value="eFlag_TownState_EuropeanCity">
				<SequenceUnit>
				  <type>SetFlag</type>
				  <param>
					<FlagName>iFlag_DayCharacter</FlagName>
					<FlagValue>1</FlagValue>
				  </param>
				</SequenceUnit>
			  </Case>
			  <Case flag="eFlag_LastTown" operation="E" value="eFlag_TownState_NYCity">
				<SequenceUnit>
				  <type>SetFlag</type>
				  <param>
					<FlagName>iFlag_DayCharacter</FlagName>
					<FlagValue>2</FlagValue>
				  </param>
				</SequenceUnit>
			  </Case>
			  <Case flag="eFlag_LastTown" operation="E" value="eFlag_TownState_China">
				<SequenceUnit>
				  <type>SetFlag</type>
				  <param>
					<FlagName>iFlag_DayCharacter</FlagName>
					<FlagValue>3</FlagValue>
				  </param>
				</SequenceUnit>
			  </Case>
			  <Case flag="eFlag_LastTown" operation="E" value="eFlag_TownState_Africa">
				<SequenceUnit>
				  <type>SetFlag</type>
				  <param>
					<FlagName>iFlag_DayCharacter</FlagName>
					<FlagValue>4</FlagValue>
				  </param>
				</SequenceUnit>
			  </Case>
			  <Case flag="eFlag_LastTown" operation="E" value="eFlag_TownState_PetraCapital">
				<SequenceUnit>
				  <type>SetFlag</type>
				  <param>
					<FlagName>iFlag_DayCharacter</FlagName>
					<FlagValue>5</FlagValue>
				  </param>
				</SequenceUnit>
			  </Case>
			  <Case flag="eFlag_LastTown" operation="E" value="eFlag_TownState_EggManBase"> <!--Skip this-->
				<SequenceUnit>
				  <type>SetFlag</type>
				  <param>
					<FlagName>iFlag_DayCharacter</FlagName>
					<FlagValue>6</FlagValue>
				  </param>
				</SequenceUnit>
			  </Case>
			  <Case flag="eFlag_LastTown" operation="E" value="eFlag_TownState_Snow">
				<SequenceUnit>
				  <type>SetFlag</type>
				  <param>
					<FlagName>iFlag_DayCharacter</FlagName>
					<FlagValue>7</FlagValue>
				  </param>
				</SequenceUnit>
			  </Case>
			  <Case flag="eFlag_LastTown" operation="E" value="eFlag_TownState_Mykonos">
				<SequenceUnit>
				  <type>SetFlag</type>
				  <param>
					<FlagName>iFlag_DayCharacter</FlagName>
					<FlagValue>8</FlagValue>
				  </param>
				</SequenceUnit>
			  </Case>
			  <Case flag="eFlag_LastTown" operation="E" value="eFlag_TownState_SouthEastAsia">
				<SequenceUnit>
				  <type>SetFlag</type>
				  <param>
					<FlagName>iFlag_DayCharacter</FlagName>
					<FlagValue>9</FlagValue>
				  </param>
				</SequenceUnit>
			  </Case>
		    </Switch>
			<SequenceUnit>
			<type>ChangeStage</type>
				<param>
				  <StageType>Menu</StageType>
				  <SettingName>Reload</SettingName>
				</param>
			</SequenceUnit>
		  </Case>
		</Switch>
  </Case>
  <Case flag="eFlag_TownState" operation="E" value="eFlag_TownState_Night">
		<Switch>
		  <Case flag="iFlag_NightCharacter" operation="GE" value="1">
		    <SequenceUnit>
		      <type>SetFlag</type>
			  <param>
			    <FlagName>iFlag_NightCharacter</FlagName>
			    <FlagValue>0</FlagValue>
			  </param>
		    </SequenceUnit>
		  </Case>
		  <Case flag="iFlag_NightCharacter" operation="E" value="0">
			<Switch>
			  <Case flag="eFlag_LastTown" operation="E" value="eFlag_TownState_EuropeanCity">
				<SequenceUnit>
				  <type>SetFlag</type>
				  <param>
					<FlagName>iFlag_NightCharacter</FlagName>
					<FlagValue>1</FlagValue>
				  </param>
				</SequenceUnit>
			  </Case>
			  <Case flag="eFlag_LastTown" operation="E" value="eFlag_TownState_NYCity">
				<SequenceUnit>
				  <type>SetFlag</type>
				  <param>
					<FlagName>iFlag_NightCharacter</FlagName>
					<FlagValue>2</FlagValue>
				  </param>
				</SequenceUnit>
			  </Case>
			  <Case flag="eFlag_LastTown" operation="E" value="eFlag_TownState_China">
				<SequenceUnit>
				  <type>SetFlag</type>
				  <param>
					<FlagName>iFlag_NightCharacter</FlagName>
					<FlagValue>3</FlagValue>
				  </param>
				</SequenceUnit>
			  </Case>
			  <Case flag="eFlag_LastTown" operation="E" value="eFlag_TownState_Africa">
				<SequenceUnit>
				  <type>SetFlag</type>
				  <param>
					<FlagName>iFlag_NightCharacter</FlagName>
					<FlagValue>4</FlagValue>
				  </param>
				</SequenceUnit>
			  </Case>
			  <Case flag="eFlag_LastTown" operation="E" value="eFlag_TownState_PetraCapital">
				<SequenceUnit>
				  <type>SetFlag</type>
				  <param>
					<FlagName>iFlag_NightCharacter</FlagName>
					<FlagValue>5</FlagValue>
				  </param>
				</SequenceUnit>
			  </Case>
			  <Case flag="eFlag_LastTown" operation="E" value="eFlag_TownState_EggManBase"> <!--Skip this-->
				<SequenceUnit>
				  <type>SetFlag</type>
				  <param>
					<FlagName>iFlag_DayCharacter</FlagName>
					<FlagValue>6</FlagValue>
				  </param>
				</SequenceUnit>
			  </Case>
			  <Case flag="eFlag_LastTown" operation="E" value="eFlag_TownState_Snow">
				<SequenceUnit>
				  <type>SetFlag</type>
				  <param>
					<FlagName>iFlag_NightCharacter</FlagName>
					<FlagValue>7</FlagValue>
				  </param>
				</SequenceUnit>
			  </Case>
			  <Case flag="eFlag_LastTown" operation="E" value="eFlag_TownState_Mykonos">
				<SequenceUnit>
				  <type>SetFlag</type>
				  <param>
					<FlagName>iFlag_NightCharacter</FlagName>
					<FlagValue>8</FlagValue>
				  </param>
				</SequenceUnit>
			  </Case>
			  <Case flag="eFlag_LastTown" operation="E" value="eFlag_TownState_SouthEastAsia">
				<SequenceUnit>
				  <type>SetFlag</type>
				  <param>
					<FlagName>iFlag_NightCharacter</FlagName>
					<FlagValue>9</FlagValue>
				  </param>
				</SequenceUnit>
			  </Case>
			</Switch>
			<SequenceUnit>
			<type>ChangeStage</type>
				<param>
				  <StageType>Menu</StageType>
				  <SettingName>Reload</SettingName>
				</param>
			</SequenceUnit>
		  </Case>
		</Switch>
  </Case>
</Switch>
</MicroSequence>
</syntaxhighlight>The case statements for the modifiable scripts and their referencers in the '''SR_Enter''' scripts have changed as such:<syntaxhighlight lang="xml">
Before: <Case flag="bFlag_is{modifiable text}" operation="E" value="true">

After:  <Case flag="iFlag_DayCharacter" operation="E" value="{modifiable number}">
</syntaxhighlight>

==== Addtional Info: ====

* EggmanLand region does not function for "iFlag_NightCharacter" & "iFlag_SuperCharacter".