Difference between revisions of "Osiris/API/StartCameraSpline"
From Divinity Engine Wiki
m (Mention result of specifying NULL as character) |
m |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
* call '''StartCameraSpline'''(''(SPLINEGUID)'''''_Spline''', ''(CHARACTERGUID)'''''_Character''', ''(REAL)'''''_FadeTime''', ''(INTEGER)'''''_HideUI''', ''(INTEGER)'''''_Freeze''', ''(INTEGER)'''''_StartIndex''') | * call '''StartCameraSpline'''(''(SPLINEGUID)'''''_Spline''', ''(CHARACTERGUID)'''''_Character''', ''(REAL)'''''_FadeTime''', ''(INTEGER)'''''_HideUI''', ''(INTEGER)'''''_Freeze''', ''(INTEGER)'''''_StartIndex''') | ||
===== Description ===== | ===== Description ===== | ||
| − | Makes the game camera for the user controlling '''_Character''' move along '''_Spline'''. The screen will start black and fade in during '''_FadeTime''' seconds when the spline starts, and fade out again over the same period before the end of the spline. If '''_Freeze''' is '''1''', the character gets [[Osiris/API/CharacterFreeze|story-frozen]] while the camera spline is active. '''_StartIndex''' specifies the index of the spline at which the camera should start. | + | Makes the game camera for the user controlling '''_Character''' move along '''_Spline'''. The screen will start black and fade in during '''_FadeTime''' seconds when the spline starts, and fade out again over the same period before the end of the spline. If '''_HideUI''' is '''1''', the hotbar and other UI elements will be hidden while the camera is active. If '''_Freeze''' is '''1''', the character gets [[Osiris/API/CharacterFreeze|story-frozen]] while the camera spline is active. '''_StartIndex''' specifies the index of the spline at which the camera should start. |
| − | The camera will move along the spline until it reaches the end of the spline. | + | The camera will move along the spline until it reaches the end of the spline, unless it is a looping spline. |
===== Notes ===== | ===== Notes ===== | ||
* Splines work as unskippable cut scenes. Be careful to keep them short as to not annoy players. | * Splines work as unskippable cut scenes. Be careful to keep them short as to not annoy players. | ||
| Line 13: | Line 13: | ||
* [[Osiris/API/StopCameraSpline|StopCameraSpline]] | * [[Osiris/API/StopCameraSpline|StopCameraSpline]] | ||
| − | [[Category:Osiris Calls]] | + | [[Category:Osiris Calls|StartCameraSpline]] |
Latest revision as of 16:26, 19 December 2017
Full Definition(s)
- call StartCameraSpline((SPLINEGUID)_Spline, (CHARACTERGUID)_Character, (REAL)_FadeTime, (INTEGER)_HideUI, (INTEGER)_Freeze, (INTEGER)_StartIndex)
Description
Makes the game camera for the user controlling _Character move along _Spline. The screen will start black and fade in during _FadeTime seconds when the spline starts, and fade out again over the same period before the end of the spline. If _HideUI is 1, the hotbar and other UI elements will be hidden while the camera is active. If _Freeze is 1, the character gets story-frozen while the camera spline is active. _StartIndex specifies the index of the spline at which the camera should start.
The camera will move along the spline until it reaches the end of the spline, unless it is a looping spline.
Notes
- Splines work as unskippable cut scenes. Be careful to keep them short as to not annoy players.
- If you specify NULL as _Character, the camera spline will be activated for all player characters.
- Before DOS2 Patch 6, camera splines do not get properly saved/restored to/from savegames.
