Difference between revisions of "LoadCutscene"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) m (1 revision: Importing auto-generated function articles) |
BryanDerksen (Talk | contribs) (fix parameters, remove tag) |
||
Line 1: | Line 1: | ||
− | |||
{{dafunction | {{dafunction | ||
|name=LoadCutscene | |name=LoadCutscene | ||
Line 12: | Line 11: | ||
|param3name=bPlayImmediately | |param3name=bPlayImmediately | ||
|param3desc=Takes over control on the client and forces the load in one big hit, then plays it automatically | |param3desc=Takes over control on the client and forces the load in one big hit, then plays it automatically | ||
− | |param4type=string | + | |param4type=string |
+ | |param4arra=TRUE | ||
|param4name=aTargetTagsToReplace | |param4name=aTargetTagsToReplace | ||
|param4desc=The tags of the actors that should be replaced (tag aTargetTagsToReplace[0] will be replaced by object aReplacementObjects[0]) | |param4desc=The tags of the actors that should be replaced (tag aTargetTagsToReplace[0] will be replaced by object aReplacementObjects[0]) | ||
− | |param5type=object | + | |param5type=object |
+ | |param5arra=TRUE | ||
|param5name=aReplacementObjects | |param5name=aReplacementObjects | ||
|param5desc=The object ids of the objects that will override the appearances of the actors specified in aTargetTagsToReplace | |param5desc=The object ids of the objects that will override the appearances of the actors specified in aTargetTagsToReplace | ||
Line 29: | Line 30: | ||
== Description == | == Description == | ||
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | <!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | ||
− | Starts off the cutscene process by loading up the cutscene in the background | + | Starts off the cutscene process by loading up the cutscene in the background while the game plays (loads a little bit each update). Will not take over control of the input or interfere with the user's play experience, except for the slight slow-down while the system loads up the scene. |
− | while the game plays (loads a little bit each update). Will not take over control | + | |
− | of the input or interfere with the user's play experience, except for the slight | + | If parameter actors are specified, the objects will be used to take the appearance only of the creatures and bring them into the scene. |
− | slow-down while the system loads up the scene. | + | |
− | If parameter actors are specified, the objects will be used to take the appearance only | + | |
− | of the creatures and bring them into the scene. | + | |
<!-- == Remarks == --> | <!-- == Remarks == --> |
Latest revision as of 22:13, 2 March 2010
Loads a cutscene
void LoadCutscene(
resource rCutscene,
object oPlayer,
int bPlayImmediately,
string[] aTargetTagsToReplace,
object[] aReplacementObjects,
int bActorsHaveWeapons
);
resource rCutscene,
object oPlayer,
int bPlayImmediately,
string[] aTargetTagsToReplace,
object[] aReplacementObjects,
int bActorsHaveWeapons
);
- Parameters:
- rCutscene
- The file name of the cutscene.cut file to load
- oPlayer
- The specific player that this cutscene is for. If none is specified, all players get it
- bPlayImmediately
- Takes over control on the client and forces the load in one big hit, then plays it automatically
- aTargetTagsToReplace
- The tags of the actors that should be replaced (tag aTargetTagsToReplace[0] will be replaced by object aReplacementObjects[0])
- aReplacementObjects
- The object ids of the objects that will override the appearances of the actors specified in aTargetTagsToReplace
- bActorsHaveWeapons
- If the actors have been overridden, do the creatures bring their weapons into the scene with them
- Returns:
- Nothing.
- Source:
- script.ldf
Description
Starts off the cutscene process by loading up the cutscene in the background while the game plays (loads a little bit each update). Will not take over control of the input or interfere with the user's play experience, except for the slight slow-down while the system loads up the scene.
If parameter actors are specified, the objects will be used to take the appearance only of the creatures and bring them into the scene.