View source for Sonic the Hedgehog (2006) EndingMode Functions

= EndingMode =
These functions are provided by <code>Sonicteam::EndingMode</code>.

== Text ==

=== Description ===
Creates a text entity for the staff roll.

=== Signature ===
 Text(mode, unknown_1, text_card, unknown_2)

==== Parameters ====
{| class="wikitable"
|+
!Parameter
!Type
!Description
!Required?
|-
|mode
|Pointer
|A pointer to <code>Sonicteam::EndingMode</code>.
|✔️
|-
|unknown_1
|Number
|This parameter is unimplemented. Usually 0.5.
|✔️
|-
|text_card
|String
|The name of the text card in <code>staff.mst</code> to use.
|✔️
|-
|unknown_2
|Number
|This parameter is unimplemented. Usually 500.
|❌
|}

=== Results ===
None.

== Sprite ==

=== Description ===
Creates a CSD resource for the staff roll and initialises the specified scene.

=== Signature ===
 Sprite(mode, unknown, csd_project, csd_scene)

==== Parameters ====
{| class="wikitable"
|+
!Parameter
!Type
!Description
!Required?
|-
|mode
|Pointer
|A pointer to <code>Sonicteam::EndingMode</code>.
|✔️
|-
|unknown
|Number
|Unknown. Always zero.
|✔️
|-
|csd_project
|String
|The path to the CSD project to load. This parameter expects a path to a <code>*.xncp</code> file without a file extension.
|✔️
|-
|csd_scene
|String
|The name of the CSD scene to use.
|✔️
|}

=== Results ===
None.

== Space ==

=== Description ===
Adds a block of padding to the staff roll.

=== Signature ===
 Space(mode, offset)

==== Parameters ====
{| class="wikitable"
|+
!Parameter
!Type
!Description
!Required?
|-
|mode
|Pointer
|A pointer to <code>Sonicteam::EndingMode</code>.
|✔️
|-
|offset
|Number
|The amount to offset the next text entity.
|✔️
|}

=== Results ===
None.

== Section ==

=== Description ===
Creates a text entity to denote a new section of the staff roll.

=== Signature ===
 Section(mode, unknown_1, text_card, unknown_2)

==== Parameters ====
{| class="wikitable"
|+
!Parameter
!Type
!Description
!Required?
|-
|mode
|Pointer
|A pointer to <code>Sonicteam::EndingMode</code>.
|✔️
|-
|unknown_1
|Number
|This parameter is unimplemented. Usually 0.5.
|✔️
|-
|text_card
|String
|The name of the text card in <code>staff.mst</code> to use.
|✔️
|-
|unknown_2
|Number
|This parameter is unimplemented. Usually 500.
|❌
|}

=== Results ===
None.

== Subsection ==

{{Notice|type=warn|content=This function is unused and has not been tested, information regarding it may be inaccurate.}}
=== Description ===
Creates a text entity to denote a new subsection of the staff roll.

=== Signature ===
 Subsection(mode, unknown_1, text_card, unknown_2)

==== Parameters ====
{| class="wikitable"
|+
!Parameter
!Type
!Description
!Required?
|-
|mode
|Pointer
|A pointer to <code>Sonicteam::EndingMode</code>.
|✔️
|-
|unknown_1
|Number
|This parameter is unimplemented.
|✔️
|-
|text_card
|String
|The name of the text card in <code>staff.mst</code> to use.
|✔️
|-
|unknown_2
|Number
|This parameter is unimplemented.
|❌
|}

=== Results ===
None.