User Tools

Site Tools


4rpl:commands:createthemeoverlay

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
4rpl:commands:createthemeoverlay [2021/02/09 15:56] – created virgilw4rpl:commands:createthemeoverlay [2021/03/22 18:45] (current) – Highlight size warning Karsten75
Line 1: Line 1:
 ~~NOTOC~~ ~~NOTOC~~
 <=[[4rpl:start| Index]] <=[[4rpl:start| Index]]
 +<WRAP tabs> 
 +  * [[4rpl:commands:clearthemeoverlay|Clear]] 
 +  * [[4rpl:commands:Createthemeoverlay|Create]] 
 +  * [[4rpl:commands:Destroythemeoverlay|Destroy]] 
 +</WRAP>
 :!: Available in version 1.3 and later. :!: Available in version 1.3 and later.
 ====== CreateThemeOverlay ====== ====== CreateThemeOverlay ======
Line 7: Line 11:
  
 ===== Description ===== ===== Description =====
-Creates an overlay texture for the specified overlay (0 or 1) with a textureWidth and textureHeight. The texture will be filled with initColor. If an overlay texture already exists, that texture will be disposed and replaced by the newly created texture.  Note that is API does essentially the same thing as loading a texture using the theme editor in the game. If you have a map and have manually loaded a texture into an overlay slot, you don't need to call CreateThemeOverlay.\\ +Creates an overlay texture for the specified overlay (0 or 1) with a textureWidth and textureHeight. The texture will be filled with initColor. If an overlay texture already exists, that texture will be disposed and replaced by the newly created texture.  Note that is API does essentially the same thing as loading a texture using the theme editor in the game. If you have a map and have manually loaded a texture into an overlay slot, you don't need to call CreateThemeOverlay. 
-Additional Note: Overlay textures are saved with the map. Don't make a texture bigger than necessary to accomplish your visual goals. The max size is 4096x4096, but such a texture could add megabytes to the map save file size.\\+ 
 + 
 +**Additional Note:** Overlay textures are saved with the map. Don't make a texture bigger than necessary to accomplish your visual goals. The max size is 2048x2048, but such a texture could add megabytes to the map save file size. 
 + 
 See [[SetThemeOverlayPixels]] for a larger example of theme overlay use. See [[SetThemeOverlayPixels]] for a larger example of theme overlay use.
  
4rpl/commands/createthemeoverlay.1612904217.txt.gz · Last modified: 2021/02/09 15:56 by virgilw