Show Picture
Show Picture¶
Displays an image on screen with configurable position, scale, and visual effects.
Properties¶
System¶
| Name | Explanation | Type |
|---|---|---|
| Color Mask | The color mask to apply to the picture. | Color |
| Height | The height to stretch the picture to. | Variable or Value |
| Height Enabled | Whether to use a custom height for the picture. | Toggle |
| Hue Shift | The hue shift to apply to the picture. | Variable or Value |
| ID | The ID of the picture to use. | Variable or Value |
| Image | The image to use for the picture. | Sprite or Model |
| Opacity | The opacity to apply to the picture. | Variable or Value |
| Persist Between Scenes | Whether the picture persists between scenes. | Switch or Value |
| Rotation (Degrees) | The rotation to apply to the picture, in degrees. | Variable or Value |
| Scale X | The X scaling to apply to the picture. | Variable or Value |
| Scale Y | The Y scaling to apply to the picture. | Variable or Value |
| Width | The width to stretch the picture to. | Variable or Value |
| Width Enabled | Whether to use a custom width for the picture. | Toggle |
| X | The X position to apply to the picture. | Variable or Value |
| Y | The Y position to apply to the picture. | Variable or Value |
| Z-Index | The Z-index to apply to the picture. | Variable or Value |
Examples¶
Show a Picture at a Specific Position¶
This displays picture ID 1 using the specified image at position (100, 50) on screen.
{"Data":{"ColorMask":{"Red":1,"Green":1,"Blue":1,"Alpha":1},"Height":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"HueShift":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"ID":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"1","VariableIndex":0,"Metadata":null},"Image":{"Name":"Content/Pictures/Background.png","SpriteFrames":1,"SpriteOrientation":0},"IsHeightEnabled":false,"IsStatic":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"SwitchIndex":0,"Value":false},"IsWidthEnabled":false,"Opacity":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"1","VariableIndex":0,"Metadata":null},"Rotation":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"ScaleX":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"1","VariableIndex":0,"Metadata":null},"ScaleY":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"1","VariableIndex":0,"Metadata":null},"Width":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"X":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"100","VariableIndex":0,"Metadata":null},"Y":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"50","VariableIndex":0,"Metadata":null},"ZIndex":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.Shared.Models.Scripts.Commands.Picture.ShowPictureCommand"}
Show a Picture Using Variable References¶
This displays a picture using global variable 0 as the ID and global variables 1 and 2 for the position.
{"Data":{"ColorMask":{"Red":1,"Green":1,"Blue":1,"Alpha":1},"Height":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"HueShift":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"ID":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":0,"Metadata":null},"Image":{"Name":"Content/Pictures/Picture.png","SpriteFrames":1,"SpriteOrientation":0},"IsHeightEnabled":false,"IsStatic":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"SwitchIndex":0,"Value":false},"IsWidthEnabled":false,"Opacity":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"1","VariableIndex":0,"Metadata":null},"Rotation":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"ScaleX":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"1","VariableIndex":0,"Metadata":null},"ScaleY":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"1","VariableIndex":0,"Metadata":null},"Width":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"X":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":1,"Metadata":null},"Y":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":2,"Metadata":null},"ZIndex":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.Shared.Models.Scripts.Commands.Picture.ShowPictureCommand"}
Show a Persistent Picture with Custom Scale and Opacity¶
This displays a picture that persists between scenes with 50% opacity and doubled scale.
{"Data":{"ColorMask":{"Red":1,"Green":1,"Blue":1,"Alpha":1},"Height":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"HueShift":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"ID":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"1","VariableIndex":0,"Metadata":null},"Image":{"Name":"Content/Pictures/Overlay.png","SpriteFrames":1,"SpriteOrientation":0},"IsHeightEnabled":false,"IsStatic":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"SwitchIndex":0,"Value":true},"IsWidthEnabled":false,"Opacity":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0.5","VariableIndex":0,"Metadata":null},"Rotation":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"ScaleX":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"2","VariableIndex":0,"Metadata":null},"ScaleY":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"2","VariableIndex":0,"Metadata":null},"Width":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"X":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"Y":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"ZIndex":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.Shared.Models.Scripts.Commands.Picture.ShowPictureCommand"}