Cabal Common Library Doc Briefing - Revision history

Svengali: formatting

2013-09-15T23:25:52Z

formatting

Svengali: added screenID

2013-02-19T12:40:31Z

added screenID

Svengali: fadeIn and repRelative added

2012-10-03T16:20:53Z

fadeIn and repRelative added

Svengali: Preparation for v1.6

2012-06-14T20:29:01Z

Preparation for v1.6

Svengali: /* Overview */

2012-05-29T22:46:26Z

‎Overview

Svengali at 23:17, 15 March 2012

2012-03-15T23:17:21Z

Svengali: added methods fcbFlightTo and fcbModelVeloTo, added actions flightTo and mVeloTo and expanded continue

2012-03-15T23:14:50Z

added methods fcbFlightTo and fcbModelVeloTo, added actions flightTo and mVeloTo and expanded continue

Svengali: cleanup

2011-12-17T00:58:50Z

cleanup

Svengali: added new methods for background and overlay pics

2011-08-19T11:58:25Z

added new methods for background and overlay pics

Svengali at 20:08, 9 August 2011

2011-08-09T20:08:45Z

@@ Line 5: / Line 5: @@
 of the displayed model. Scripts can pass the data easily and everything else is performed within the briefing script.
-{{CodeEx|codeex=worldScripts.Cabal_Common_Briefing.startBriefing(obj);}}
+  worldScripts.Cabal_Common_Briefing.startBriefing(obj);
 A second approach is possible by instantiating a copy of the underlaying API, e.g.
-{{CodeEx|codeex=this.helper = new worldScripts.Cabal_Common_Functions.Cabal_Common_ScreenFCB();}}
+  this.helper = new worldScripts.Cabal_Common_Functions.Cabal_Common_ScreenFCB();
 But scripts are then responsible to remove the framecallbacks on their own with the method provided by the API!
-Missionscreens invoked by <tt>Cabal_Common_Briefing.js</tt> are using the screenID (v1.7.1+)
+Missionscreens invoked by <tt>Cabal_Common_Briefing.js</tt> are using the screenID {{AV|1.7.1}}
 {{CodeEx|codeex="Cabal_Common_Briefing"}}
@@ Line 38: / Line 38: @@
 :;capture:Boolean. If true only a new briefing, callback and callbackf gets established. The current missionscreen is used.
 :;cornerPos:Array. Optional. Movement to one corner. E.g. [0.33,1,1,1.3]
-:;fadeIn:Boolean. Optional. If true overlay images will be used to simulate a fade in. (New in v1.6.1)
+:;fadeIn:Boolean. Optional. If true overlay images will be used to simulate a fade in. {{AV|1.6.1}}
 :;getOri:String. Optional. script_info keyname that holds orientation, e.g. "1,0,0,0".
 :;getPos:String. Optional. script_info keyname that holds position, e.g. "0,0,300".
@@ Line 48: / Line 48: @@
 :;preparePositions:Array Optional. Sets positions for subentities.
 :;prepareProps:Object. Optional. Sets properties for model and all subentities, e.g. {energy:2000,fuel:0}.
-:;repRelative:Boolean. Optional. If true relativePosition will be replaced by position in used shaders on setting up the briefing. (New in v1.6.1)
+:;repRelative:Boolean. Optional. If true relativePosition will be replaced by position in used shaders on setting up the briefing. {{AV|1.6.1}}
 :;role:String.
 :;title:String. Optional. Defaults to "Briefing".
@@ Line 54: / Line 54: @@
 A short example:
-{{CodeEx|codeex=var obj = {
+  var obj = {
-:role:"trader",<br>
+    role:"trader",
-:ori:[1,0,0,0],<br>
+    ori:[1,0,0,0],
-:briefing:[<br>
+    briefing:[
-::[3,"mVelo",[0,-1,3,-1.005,0,0,1,0,0.85]],<br>
+      [3,"mVelo",[0,-1,3,-1.005,0,0,1,0,0.85]],
-::[17,"stopVelo",[0,-1]]<br>
+      [17,"stopVelo",[0,-1]]
-:],<br>
+    ],
-:callback:this.name,<br>
+    callback:this.name,
-:callbackf:"choiceEval"<br>
+    callbackf:"choiceEval"
-};<br>
+  };
-worldScripts.Cabal_Common_Briefing.startBriefing(obj);}}
+  worldScripts.Cabal_Common_Briefing.startBriefing(obj);
 === obj.briefing ===
@@ Line 105: / Line 105: @@
 == Cabal_Common_ScreenFCB ==
 Scripts can instantiate a copy via
-{{CodeEx|codeex=this.helper = new worldScripts.Cabal_Common_Functions.Cabal_Common_ScreenFCB();}}
+  this.helper = new worldScripts.Cabal_Common_Functions.Cabal_Common_ScreenFCB();
 === Properties ===
-==== internalVersion ====
+=== internalVersion ===
 Number. Property to give OXPs a chance to check the required lib min. version easily. This number will be raised with every release.
-{{CodeEx|codeex=var a = this.helper.internalVersion;
+  var a = this.helper.internalVersion;
-a -> {{CCL_Int}}}}

@@ Line 12: / Line 12: @@
 But scripts are then responsible to remove the framecallbacks on their own with the method provided by the API!
 == Functions ==
@@ Line 33: / Line 36: @@
 :;callbackc:String. Optional. Mission choice.
 :;callbackf:String. Required. Callback function.
-:;capture:Boolean. If true only a new briefing, callback and callbackf gets established.
+:;capture:Boolean. If true only a new briefing, callback and callbackf gets established. The current missionscreen is used.
 :;cornerPos:Array. Optional. Movement to one corner. E.g. [0.33,1,1,1.3]
 :;fadeIn:Boolean. Optional. If true overlay images will be used to simulate a fade in. (New in v1.6.1)

@@ Line 35: / Line 35: @@
 :;capture:Boolean. If true only a new briefing, callback and callbackf gets established.
 :;cornerPos:Array. Optional. Movement to one corner. E.g. [0.33,1,1,1.3]
 :;getOri:String. Optional. script_info keyname that holds orientation, e.g. "1,0,0,0".
 :;getPos:String. Optional. script_info keyname that holds position, e.g. "0,0,300".
@@ Line 44: / Line 45: @@
 :;preparePositions:Array Optional. Sets positions for subentities.
 :;prepareProps:Object. Optional. Sets properties for model and all subentities, e.g. {energy:2000,fuel:0}.
 :;role:String.
 :;title:String. Optional. Defaults to "Briefing".
@@ Line 60: / Line 62: @@
 };<br>
 worldScripts.Cabal_Common_Briefing.startBriefing(obj);}}
 === obj.briefing ===

@@ Line 9: / Line 9: @@
 A second approach is possible by instantiating a copy of the underlaying API, e.g.
-{{CodeEx|codeex=this.helper = new Cabal_Common_ScreenFCB();}}
+{{CodeEx|codeex=this.helper = new worldScripts.Cabal_Common_Functions.Cabal_Common_ScreenFCB();}}
 But scripts are then responsible to remove the framecallbacks on their own with the method provided by the API!
 == Functions ==
@@ Line 99: / Line 101: @@
 == Cabal_Common_ScreenFCB ==
 Scripts can instantiate a copy via
-{{CodeEx|codeex=this.helper = new Cabal_Common_ScreenFCB();}}
+{{CodeEx|codeex=this.helper = new worldScripts.Cabal_Common_Functions.Cabal_Common_ScreenFCB();}}

@@ Line 1: / Line 1: @@
 == Overview ==
-This is the main class for the briefing with its members.
+This is the main class for the briefing with its members and part of the [[Cabal_Common_Library]].
 The script handles incoming data from worldScripts to make missionscreens a bit more interesting with time based animations
@@ Line 11: / Line 11: @@
 {{CodeEx|codeex=this.helper = new Cabal_Common_ScreenFCB();}}
 But scripts are then responsible to remove the framecallbacks on their own with the method provided by the API!
 == Functions ==

@@ Line 75: / Line 75: @@
 *'''bind''' - Sticks two subents together. See [[#fcbSetBinding()|fcbSetBinding()]].
 *'''check''' - Useful for developers to see how many framecallbacks are invoked. See [[#fcbCheckAll()|fcbCheckAll()]].
 *'''continue''' - Enables checkpoints if specific points are reached. If callback function returns number, this is used as goto command.
 *'''face''' - Rotate entity to face another entity. See [[#fcbFace()|fcbFace()]].

@@ Line 64: / Line 64: @@
 The briefing array contains the timebased actions. A entry contains at least two elements:
 :;Time:Number. Based on a interval of 0.25 sec.
-:;Action:String. Specifier for the action. Most actions will need additional parameter.
+:;Action:String. Specifier for the action.
 Short overview about the actions:
@@ Line 70: / Line 70: @@
 *'''bind''' - Sticks two subents together. See [[#fcbSetBinding()|fcbSetBinding()]].
 *'''check''' - Useful for developers to see how many framecallbacks are invoked. See [[#fcbCheckAll()|fcbCheckAll()]].
-*'''continue''' - Enables checkpoints if specific points are reached.
+*'''continue''' - Enables checkpoints if specific points are reached. If callback function returns number, this is used as goto command.
 *'''face''' - Rotate entity to face another entity. See [[#fcbFace()|fcbFace()]].
 *'''kill''' - Stops briefing and clears all fcbs. See [[#fcbRemoveAll()|fcbRemoveAll()]].
 *'''mes''' - Add a message.
 *'''mSpeed''' - Velocity based on vectorForward. See [[#fcbModelSpeed()|fcbModelSpeed()]].
 *'''mVelo''' - Velocity vectorUp, Right and Forward. See [[#fcbModelVelo()|fcbModelVelo()]].
 *'''prop''' - Set property, e.g. fuel. See [[#fcbSetProp()|fcbSetProp()]].
 *'''reback''' - Set background image. See [[#reBackground()|reBackground()]].
@@ Line 144: / Line 146: @@
 :;rF:Number. Rotate vectorForward by rF (radians).
 :;velo:Number. Multiply vectorForward and set velocity. If -1 no velocity set.
 '''Returns:'''
@@ Line 180: / Line 200: @@
 :;dampa:Number. Linear dampening duration for start.
 :;dampb:Number. Linear dampening duration for end.
 '''Returns:'''

@@ Line 77: / Line 77: @@
 *'''mVelo''' - Velocity vectorUp, Right and Forward. See [[#fcbModelVelo()|fcbModelVelo()]].
 *'''prop''' - Set property, e.g. fuel. See [[#fcbSetProp()|fcbSetProp()]].
-*'''reback''' - Set background image. See [[#reBackground()|reBackground()]]. (New in v1.4.5)
+*'''reback''' - Set background image. See [[#reBackground()|reBackground()]].
 *'''reori''' - Set orientation. See [[#reOrient()|reOrient()]].
-*'''reover''' - Set overlay image. See [[#reOverlay()|reOverlay()]]. (New in v1.4.5)
+*'''reover''' - Set overlay image. See [[#reOverlay()|reOverlay()]].
 *'''repos''' - Set position. See [[#rePosition()|rePosition()]].
 *'''retex''' - Set materials/shaders. See [[#reTexture()|reTexture()]].
@@ Line 304: / Line 304: @@
 {{CodeEx|codeex=this.helper.reBackground(png);}}
 Set background image.
 '''Parameters:'''
@@ Line 329: / Line 328: @@
 {{CodeEx|codeex=this.helper.reOverlay(png);}}
 Set overlay image.
 '''Parameters:'''

@@ Line 34: / Line 34: @@
 :;capture:Boolean. If true only a new briefing, callback and callbackf gets established.
 :;cornerPos:Array. Optional. Movement to one corner. E.g. [0.33,1,1,1.3]
-:;getOri:String. Optional. script_info keyname that holds orientation, e.g. "1,0,0,0". (New in v1.4.4)
+:;getOri:String. Optional. script_info keyname that holds orientation, e.g. "1,0,0,0".
-:;getPos:String. Optional. script_info keyname that holds position, e.g. "0,0,300". (New in v1.4.4)
+:;getPos:String. Optional. script_info keyname that holds position, e.g. "0,0,300".
 :;music:String. Optional. Filename with extension.
 :;ori:Array. Optional. Orientation. E.g. [1,0,0,0].
 :;overlay:String. Optional. Filename with extension. Defaults to "bgs-i_overlay_none.png" if BGS-A or BGS-I installed.
-:;prepareBindings:Array. Optional. Sets bindings for subentities. (New in v1.4.4)
+:;prepareBindings:Array. Optional. Sets bindings for subentities.
-:;prepareOrientations:Array. Optional. Sets orientations for subentities. (New in v1.4.4)
+:;prepareOrientations:Array. Optional. Sets orientations for subentities.
-:;preparePositions:Array Optional. Sets positions for subentities. (New in v1.4.4)
+:;preparePositions:Array Optional. Sets positions for subentities.
-:;prepareProps:Object. Optional. Sets properties for model and all subentities, e.g. {energy:2000,fuel:0}. (New in v1.4.4)
+:;prepareProps:Object. Optional. Sets properties for model and all subentities, e.g. {energy:2000,fuel:0}.
 :;role:String.
 :;title:String. Optional. Defaults to "Briefing".
@@ Line 77: / Line 77: @@
 *'''mVelo''' - Velocity vectorUp, Right and Forward. See [[#fcbModelVelo()|fcbModelVelo()]].
 *'''prop''' - Set property, e.g. fuel. See [[#fcbSetProp()|fcbSetProp()]].
 *'''reori''' - Set orientation. See [[#reOrient()|reOrient()]].
 *'''repos''' - Set position. See [[#rePosition()|rePosition()]].
-*'''retex''' - Set materials/shaders. See [[#reTexture()|reTexture()]]. (New in v1.4.4)
+*'''retex''' - Set materials/shaders. See [[#reTexture()|reTexture()]].
 *'''rot''' - Rotate X,Y,Z. See [[#fcbRotation()|fcbRotation()]].
 *'''stopSound''' - Stop briefing sound.
@@ Line 222: / Line 224: @@
 :;last:Number. Duration for fcb.
 :;tar:Entity. Target subEntity.
-:;dist:Boolean. Keep its distance. (New in v1.4.4)
+:;dist:Boolean. Keep its distance.
 :;inheritFE:Boolean. Bind fuel and energy too.
-:;swap:Boolean. Flip orientation. (New in v1.4.4)
+:;swap:Boolean. Flip orientation.
 '''Returns:'''
@@ Line 294: / Line 296: @@
 :;dampa:Number. Linear dampening duration for start.
 :;dampb:Number. Linear dampening duration for end.
 '''Returns:'''
@@ Line 307: / Line 321: @@
 :;sub:SubEntity. If -1 main entity is used, otherwise ent.subEntities[sub].
 :;ori:Array. Orientation in w,x,y,z.
 '''Returns:'''
@@ Line 328: / Line 354: @@
 {{CodeEx|codeex=this.helper.rePosition(ent,sub,mat,sha);}}
 Set materials and shaders.
 '''Parameters:'''