Difference between revisions of "Component: String Initialiser (Storage)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix Ltd
 
| Matrix Ltd
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.0 (Release)
+
| 1.0
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Storage
 
| Storage
 
|}
 
|}
  
 +
 +
==String Initialiser component==
 +
A component allowing an easy way to initialise string variables using ROM memory. A simple and efficient way to populate string variables helping to save on RAM usage. Allows up to 16 strings to be stored. For additional strings simply use more String Initialiser components.
 +
 +
==Component Pack==
 +
 +
STORAGE
 +
 +
==Detailed description==
  
  
−
==[[File:Component Icon a8abdc98_224c_4c8a_8311_2921cb3dbe46.png|Image]] String Initialiser component==
 
−
A component allowing an easy way to initialise string variables using ROM memory.
 
−
A simple and efficient way to populate string variables helping to save on RAM usage.
 
−
Allows up to 16 strings to be stored. For additional strings simply use more String Initialiser components.
 
  
−
==Examples==
 
−
''<span style="color:red;">No additional examples</span>''
 
  
  
−
==Downloadable macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>GetString</tt></u></span>===
 
−
Gets a string stored in ROM memory and loads into a RAM string variable
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''Index''
 
−
::Range: 0-15 Depending on number of strings
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|STRING]]
+
''No detailed description exists yet for this component''
  
 +
==Examples==
  
  
−
==Simulation macro reference==
 
  
−
''This component does not contain any simulation macros''
 
  
  
−
==Property reference==
 
−
<span style="font-weight: normal;"><u>Number of Strings</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''NumStrings''.
 
  
−
''<span style="color:red;">No additional information</span>''
 
  
  
  
−
<span style="font-weight: normal;"><u>String 0</u></span>
 
  
−
This property is of type ''Line of text'' and can be referenced with the variable name ''Str0''.
 
  
−
String data index 0
+
''<span style="color:red;">No additional examples</span>''
  
−
<span style="font-weight: normal;"><u>String 1</u></span>
 
  
−
This property is of type ''Line of text'' and can be referenced with the variable name ''Str1''.
+
==Downloadable macro reference==
  
−
String data index 1
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetString'''
 +
|-
 +
| colspan="2" | Gets a string stored in ROM memory and loads into a RAM string variable&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | Range: 0-15 Depending on number of strings&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 
 +
 
 +
 
 +
 
 +
==Property reference==
 +
 
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Number of Strings
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 +
| width="90%" | String 0
 +
|-
 +
| colspan="2" | String data index 0&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 +
| width="90%" | String 1
 +
|-
 +
| colspan="2" | String data index 1&nbsp;
 +
|}

Latest revision as of 17:24, 9 November 2022

Author Matrix Ltd
Version 1.0
Category Storage


String Initialiser component

A component allowing an easy way to initialise string variables using ROM memory. A simple and efficient way to populate string variables helping to save on RAM usage. Allows up to 16 strings to be stored. For additional strings simply use more String Initialiser components.

Component Pack

STORAGE

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png GetString
Gets a string stored in ROM memory and loads into a RAM string variable 
Fc9-u8-icon.png - BYTE Index
Range: 0-15 Depending on number of strings 
Fc9-string-icon.png - STRING Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Number of Strings
 
Fc9-type-10-icon.png String 0
String data index 0 
Fc9-type-10-icon.png String 1
String data index 1 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_String_Initialiser_(Storage)&oldid=28889"