Difference between revisions of "Cabal Common Library Doc Briefing"
m |
m |
||
Line 1: | Line 1: | ||
+ | {{Stub}} |
||
== Overview == |
== Overview == |
||
This is the main class for the briefing with its members. |
This is the main class for the briefing with its members. |
||
Line 15: | Line 16: | ||
=== startBriefing() === |
=== startBriefing() === |
||
{{CodeEx|codeex=worldScripts.Cabal_Common_Briefing.startBriefing = function( obj )}} |
{{CodeEx|codeex=worldScripts.Cabal_Common_Briefing.startBriefing = function( obj )}} |
||
− | Calling this method starts the handling. The |
+ | Calling this method starts the handling. The passed obj must hold a few parameters to define the actions. |
− | obj: |
||
'''Parameters:''' |
'''Parameters:''' |
||
− | :;absolutePos:Array. Optional. |
||
+ | :;obj:Object. |
||
+ | |||
+ | '''Returns:''' |
||
+ | :;nothing |
||
+ | |||
+ | |||
+ | '''Properties of obj:''' |
||
+ | :;absolutePos:Array. Optional. E.g. [10,12,540]. |
||
:;background:String. Optional. Filename with extension. |
:;background:String. Optional. Filename with extension. |
||
:;briefing:Array. Required. Action commands. |
:;briefing:Array. Required. Action commands. |
||
Line 26: | Line 33: | ||
:;callbackf:String. Required. Callback function. |
:;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. |
||
− | :;cornerPos:Array. Optional. Movement to one corner. |
+ | :;cornerPos:Array. Optional. Movement to one corner. E.g. [0.33,1,1,1.3] |
:;music:String. Optional. Filename with extension. |
:;music:String. Optional. Filename with extension. |
||
− | :;ori:Array. Optional. Orientation. |
+ | :;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. |
:;overlay:String. Optional. Filename with extension. Defaults to "bgs-i_overlay_none.png" if BGS-A or BGS-I installed. |
||
:;role:String. |
:;role:String. |
||
:;title:String. Optional. Defaults to "Briefing". |
:;title:String. Optional. Defaults to "Briefing". |
||
− | '''Returns:''' |
||
− | :;nothing |
||
Example: |
Example: |
||
Line 50: | Line 55: | ||
− | == obj.briefing == |
+ | === obj.briefing === |
− | + | 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. |
− | + | ||
− | + | Short overview about the actions: |
|
− | + | *'''bgzoom''' - Zooms background image in and out. |
|
− | + | *'''bind''' - Sticks two subents together. |
|
− | + | *'''check''' - Useful for developers to see how many framecallbacks are invoked. |
|
− | + | *'''continue''' - Enables checkpoints if specific points are reached. |
|
− | + | *'''face''' - Rotate entity to face another entity. |
|
− | + | *'''kill''' - Stops briefing. |
|
− | + | *'''mes''' - Add a message. |
|
− | + | *'''mSpeed''' - Velocity based on vectorForward. |
|
− | + | *'''mVelo''' - Velocity vectorUp, Right and Forward. |
|
− | + | *'''prop''' - Set property, e.g. fuel. |
|
− | + | *'''reori''' - Set orientation. |
|
− | + | *'''repos''' - Set position. |
|
− | + | *'''rot''' - Rotate X,Y,Z. |
|
− | + | *'''stopSound''' - Stop briefing sound. |
|
+ | *'''stopVelo''' - Stop velocity. |
||
+ | *'''turn''' - Rotate vectorUp, Right and Forward and velocity. |
||
+ | *'''walk''' - Subtract Z-position, biased Y. |
||
+ | *'''zoom''' - Multiplied position. |
||
+ | |||
+ | |||
+ | == Cabal_Common_ScreenFCB == |
||
+ | Scripts can instantiate a copy via |
||
+ | {{CodeEx|codeex=this.helper = new Cabal_Common_ScreenFCB();}} |
||
+ | |||
+ | |||
+ | === Properties === |
||
+ | ==== 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; |
||
+ | a -> 5}} |
||
+ | |||
+ | |||
+ | === Methods === |
||
...more... |
...more... |
Revision as of 20:31, 4 June 2011
- This article is a stub. You can help EliteWiki by expanding it.
Contents
Overview
This is the main class for the briefing with its members.
The script handles incoming data from worldScripts to make missionscreens a bit more interesting with time based animations of the displayed model. Scripts can pass the data easily and everything else is performed within the briefing script.
worldScripts.Cabal_Common_Briefing.startBriefing(obj); |
A second approach is possible by instantiating a copy of the underlaying API, e.g.
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
startBriefing()
worldScripts.Cabal_Common_Briefing.startBriefing = function( obj ) |
Calling this method starts the handling. The passed obj must hold a few parameters to define the actions.
Parameters:
- obj
- Object.
Returns:
- nothing
Properties of obj:
- absolutePos
- Array. Optional. E.g. [10,12,540].
- background
- String. Optional. Filename with extension.
- briefing
- Array. Required. Action commands.
- callback
- String. Required. WorldScript identifier.
- callbackc
- String. Optional. Mission choice.
- callbackf
- String. Required. Callback function.
- 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]
- 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.
- role
- String.
- title
- String. Optional. Defaults to "Briefing".
Example:
var obj = {
role:"trader", |
obj.briefing
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.
Short overview about the actions:
- bgzoom - Zooms background image in and out.
- bind - Sticks two subents together.
- check - Useful for developers to see how many framecallbacks are invoked.
- continue - Enables checkpoints if specific points are reached.
- face - Rotate entity to face another entity.
- kill - Stops briefing.
- mes - Add a message.
- mSpeed - Velocity based on vectorForward.
- mVelo - Velocity vectorUp, Right and Forward.
- prop - Set property, e.g. fuel.
- reori - Set orientation.
- repos - Set position.
- rot - Rotate X,Y,Z.
- stopSound - Stop briefing sound.
- stopVelo - Stop velocity.
- turn - Rotate vectorUp, Right and Forward and velocity.
- walk - Subtract Z-position, biased Y.
- zoom - Multiplied position.
Cabal_Common_ScreenFCB
Scripts can instantiate a copy via
this.helper = new Cabal_Common_ScreenFCB(); |
Properties
internalVersion
Number. Property to give OXPs a chance to check the required lib min. version easily. This number will be raised with every release.
var a = this.helper.internalVersion;
a -> 5 |
Methods
...more...