- This wiki is out of date, use the continuation of this wiki instead
Start scroll
From FenixWiki
(Difference between revisions)
| Revision as of 22:36, 11 April 2007 (edit) 88.107.144.169 (Talk) ← Previous diff |
Revision as of 00:35, 16 April 2007 (edit) (undo) Sandman (Talk | contribs) (Tidied) Next diff → |
||
| Line 1: | Line 1: | ||
| ==Definition== | ==Definition== | ||
| - | + | '''INT''' Start_scroll ( <'''INT''' scrollnumber> , <'''INT''' file> , <'''INT''' graphic> , <'''INT''' backgroundgraphic> , <'''INT''' regionnumber> , <'''INT''' locking indicator> ) | |
| - | This creates a scroll window in which it will perform a view against a background graphic. That is, by using a graphic bigger than the display window, a part of this graphic can be shown and shifted in any direction. | + | This creates a scroll window in which it will perform a view against a background [[graphic]]. That is, by using a graphic bigger than the display window, a part of this graphic can be shown and shifted in any direction. |
| - | == Returns == | ||
| - | |||
| - | Nothing | ||
| == Parameters == | == Parameters == | ||
| - | ''' | + | {| |
| + | | '''INT''' Number of scroll || - the id for the new scroll window, so it can be referenced to later | ||
| + | |- | ||
| + | | '''INT''' File || - the [[fpg]] containing the scroll graphics | ||
| + | |- | ||
| + | | '''INT''' Graphic || - the [[graphic code]] of the main graphic to be scrolled | ||
| + | |- | ||
| + | | '''INT''' Background graphic || - the [[graphic code]] for the background of the scroll window (deeper than the main graphic) | ||
| + | |- | ||
| + | | '''INT''' Number of region || - the [[region]] in which to put the scroll window | ||
| + | |- | ||
| + | | '''INT''' Locking indicator || - A value defining whether each of the two scroll planes is horizontally and vertically cyclical | ||
| + | |- | ||
| + | |} | ||
| - | '''File''' - the [[fpg]] containing the scroll graphics | ||
| - | ''' | + | == Returns == |
| + | |||
| + | '''INT''' - Nothing | ||
| - | '''Background graphic''' - the [[graphic code]] for the background of the scroll window (deeper than the main graphic) | ||
| - | + | == Notes == | |
| - | + | The locking indicator can be combinations of the following flags: | |
| + | {| | ||
| + | | 1 || - The foreground will be displayed horizontally cycical | ||
| + | |- | ||
| + | | 2 || - The foreground will be displayed vertically cycical | ||
| + | |- | ||
| + | | 4 || - The background will be displayed horizontally cycical | ||
| + | |- | ||
| + | | 8 || - The background will be displayed vertically cycical | ||
| + | |} | ||
| - | + 1 - If the foreground is horizontally cyclical. | ||
| - | + 2 - If the foreground is vertically cyclical. | ||
| - | + 4 - If the background is horizontally cyclical. | ||
| - | + 8 - If the background is vertically cyclical. | ||
| == Using Scrolling == | == Using Scrolling == | ||
| - | For each [[process]] that you want to be part of a scroll window, you must set the variable [[c_type]] to value 'c_scroll'. Additionally, you must set the camera property of the [[scroll structure]] to the [[identifying code]] of the process you wish to be followed. | + | For each [[process]] that you want to be part of a [[scroll window]], you must set the [[variable]] [[c_type]] to value 'c_scroll'. Additionally, you must set the camera property of the [[scroll structure]] to the [[identifying code]] of the [[process]] you wish to be followed. |
| [[Category:functions]] | [[Category:functions]] | ||
Revision as of 00:35, 16 April 2007
Contents |
Definition
INT Start_scroll ( <INT scrollnumber> , <INT file> , <INT graphic> , <INT backgroundgraphic> , <INT regionnumber> , <INT locking indicator> )
This creates a scroll window in which it will perform a view against a background graphic. That is, by using a graphic bigger than the display window, a part of this graphic can be shown and shifted in any direction.
Parameters
| INT Number of scroll | - the id for the new scroll window, so it can be referenced to later |
| INT File | - the fpg containing the scroll graphics |
| INT Graphic | - the graphic code of the main graphic to be scrolled |
| INT Background graphic | - the graphic code for the background of the scroll window (deeper than the main graphic) |
| INT Number of region | - the region in which to put the scroll window |
| INT Locking indicator | - A value defining whether each of the two scroll planes is horizontally and vertically cyclical |
Returns
INT - Nothing
Notes
The locking indicator can be combinations of the following flags:
| 1 | - The foreground will be displayed horizontally cycical |
| 2 | - The foreground will be displayed vertically cycical |
| 4 | - The background will be displayed horizontally cycical |
| 8 | - The background will be displayed vertically cycical |
Using Scrolling
For each process that you want to be part of a scroll window, you must set the variable c_type to value 'c_scroll'. Additionally, you must set the camera property of the scroll structure to the identifying code of the process you wish to be followed.
