Cabal Common Library Doc Overlay - Revision history

Svengali: formatting

2013-09-15T23:39:51Z

formatting

Svengali at 10:52, 5 March 2013

2013-03-05T10:52:28Z

Svengali: added coloring and decals

2013-02-22T13:11:36Z

added coloring and decals

Svengali at 13:36, 22 November 2012

2012-11-22T13:36:27Z

Svengali: started doc for overlay script

2012-10-24T17:00:46Z

started doc for overlay script

New page

== Overview ==
This is the main class for the overlay helpers with its members and part of the [[Cabal_Common_Library]].

It handles 19 slots for inflight overlays (10x characters, 9x notifications) and uses shaders to place them on screen
and works in a similiar way to the overlays in [[Vector_OXP|Vector]] (this OXP will be changed to use this mechanism).

== Methods ==
=== ovAdd()===
{{CodeEx|codeex=worldScripts.Cabal_Common_Overlay.ovAdd( obj, off )}}
Adds overlay to one of the available slots. Added overlays will stay inflight until the calling script explicitely removes them, the VisualEffect becomes invalid or the autoremove option is used. All overlays will be removed when the player docks or leaves the system, but are respawned (offscreen) when the player launches or enters a new system. The script does not store anything to the savedgame though, so scripts are responsible to add them if necessary.

'''Parameters:'''
:;obj:Object. Properties see below.
:;off:Boolean. If true overlay is added, but offscreen.

'''Returns:'''
:;result:VisualEffect or false.

'''Properties:'''
:;cclov_id:String. Unique Identifier.
:;cclov_type:Number. 0=Notification, 1=Character.
:;cclov_blend:Number. Duration for effect in seconds. Set to -1 for permanent.
:;cclov_autoremove:Boolean. Removes effect after cclov_blend seconds.
:;cclov_fx:String. VisualEffect to be used instead.
:;cclov_png:String/Texture. Must be specified if cclov_fx is not used.
:;cclov_color:Array. Color in rgb. Values should be in range 0...3.

=== ovSpeak() ===
{{CodeEx|codeex=worldScripts.Cabal_Common_Overlay.ovSpeak( who, cclov_blend, message, whom, autoremove )}}
Lights up the overlay.

'''Parameters:'''
:;who:String. Identifier (see [[#ovAdd()|ovAdd() - cclov_id]]).
:;cclov_blend:Number. Duration for effect in seconds.
:;message:String.
:;whom:Entity.
:;autoremove:Boolean. Removes effect after cclov_blend seconds.

'''Returns:'''
:;result:Boolean. True on success. Otherwise false.

=== ovRemove() ===
{{CodeEx|codeex=worldScripts.Cabal_Common_Overlay.ovRemove( who )}}
Remove specified overlay.

'''Parameters:'''
:;who:String. Identifier (see [[#ovAdd()|ovAdd() - cclov_id]]).

'''Returns:'''
:;result:Boolean. True on success. Otherwise false.

----
[[Category:OXPDoc]]

@@ Line 36: / Line 36: @@
 ::Optional.
 :;cclov_decal:Number. Bitmask for used decals for character overlays.
-::Optional. New in v1.7.1.
+::Optional. {{AV|1.7.1}}.
 :;cclov_fx:String. VisualEffect to be used instead.
 ::Optional.
@@ Line 93: / Line 93: @@
 === Decals ===
-A third option is using decals. The shader splits the texture coordinates of the input image in 4 areas. <tt>cclov_decal</tt> specifies which of the areas gets mixed with the main area. It is a bitmask value (1, 2 and 4) and processing is done in descending order to allow elements hiding each other. A value of 7 applies all decals. It can be combined with the [[#Coloring|Coloring]] option. New in v1.7.1.
+A third option is using decals. The shader splits the texture coordinates of the input image in 4 areas. <tt>cclov_decal</tt> specifies which of the areas gets mixed with the main area. It is a bitmask value (1, 2 and 4) and processing is done in descending order to allow elements hiding each other. A value of 7 applies all decals. It can be combined with the [[#Coloring|Coloring]] option. {{AV|1.7.1}}.

@@ Line 36: / Line 36: @@
 ::Optional.
 :;cclov_decal:Number. Bitmask for used decals for character overlays.
-::Optional.
+::Optional. New in v1.7.1.
 :;cclov_fx:String. VisualEffect to be used instead.
 ::Optional.
@@ Line 93: / Line 93: @@
 === Decals ===
-A third option is using decals. The shader splits the texture coordinates of the input image in 4 areas. <tt>cclov_decal</tt> specifies which of the areas gets mixed with the main area. It is a bitmask value (1, 2 and 4) and processing is done in descending order to allow elements hiding each other. A value of 7 applies all decals. It can be combined with the [[#Coloring|Coloring]] option.
+A third option is using decals. The shader splits the texture coordinates of the input image in 4 areas. <tt>cclov_decal</tt> specifies which of the areas gets mixed with the main area. It is a bitmask value (1, 2 and 4) and processing is done in descending order to allow elements hiding each other. A value of 7 applies all decals. It can be combined with the [[#Coloring|Coloring]] option. New in v1.7.1.

@@ Line 25: / Line 25: @@
 '''Properties:'''
-:;cclov_id:String. Unique Identifier. Required.
+:;cclov_id:String. Unique Identifier.
-:;cclov_type:Number. 0=Notification, 1=Character. Required.
+::Required.
 :;cclov_blend:Number. Duration for effect in seconds. Set to -1 for permanent.
 :;cclov_autoremove:Boolean. Removes effect after cclov_blend seconds.
 :;cclov_fx:String. VisualEffect to be used instead.
 :;cclov_png:String/Texture. Must be specified if cclov_fx is not used.
 === ovSpeak() ===
 {{CodeEx|codeex=worldScripts.Cabal_Common_Overlay.ovSpeak( who, cclov_blend, message, whom, autoremove )}}
 '''Parameters:'''
 :;who:String. Identifier (see [[#ovAdd()|ovAdd() - cclov_id]]).
 :;cclov_blend:Number. Duration for effect in seconds.
 :;message:String.
 :;autoremove:Boolean. Removes effect after cclov_blend seconds.
 '''Returns:'''
@@ Line 55: / Line 68: @@
 '''Parameters:'''
 :;who:String. Identifier (see [[#ovAdd()|ovAdd() - cclov_id]]).
 '''Returns:'''
 :;result:Boolean. True on success. Otherwise false.