Sign: Difference between revisions

From Virtual Paradise Wiki
Jump to navigation Jump to search
mNo edit summary
(Added missing argument "Text", fixed incorrect documentation of Noshadow/Shadow, actually made the example code match the image)
Line 4: Line 4:


==Usage==
==Usage==
     '''sign''' [''color=''] [''bcolor=''] [''margin=''] [''vmargin=''] [''hmargin=''] [''align=''] [''shadow'']
     '''sign''' [''"text"''] [''color=''] [''bcolor=''] [''margin=''] [''vmargin=''] [''hmargin=''] [''align=''] [''shadow OR noshadow'']
The text in the description field of the object is used as the text for the sign.
 
==Arguments==
==Arguments==
; Text : Text to render on the sign. If omitted, the contents of the description field is used for the text<br>'''Values:''' Text string within double-quotes (e.g. "This is a string")<br>'''Default:''' [contents of Description field]
; Color : The foreground color of the sign text<br>'''Values:''' Color Names, Hexadecimal colors<br>'''Default:''' White
; Color : The foreground color of the sign text<br>'''Values:''' Color Names, Hexadecimal colors<br>'''Default:''' White
; Bcolor : The background color of the sign<br>'''Values:''' Color Names, Hexadecimal colors<br>'''Default:''' Blue
; Bcolor : The background color of the sign<br>'''Values:''' Color Names, Hexadecimal colors<br>'''Default:''' Blue
Line 13: Line 14:
; Hmargin : The space between the left/right edges of the sign, and the left/right edges of the text<br>'''Values:''' Decimal numbers greater than 0.0<br>'''Default:''' 0.0
; Hmargin : The space between the left/right edges of the sign, and the left/right edges of the text<br>'''Values:''' Decimal numbers greater than 0.0<br>'''Default:''' 0.0
; Align : Controls the general anchor point of the text<br>'''Values:''' Left, Right, Center<br>'''Default:''' Center
; Align : Controls the general anchor point of the text<br>'''Values:''' Left, Right, Center<br>'''Default:''' Center
; Shadow : Adds a 1 Pixel black shadow to the text<br>'''Values:''' On, Off<br>'''Default:''' Off
; Noshadow OR Shadow : Adds a 1 Pixel black shadow to the text<br>'''Default:''' Noshadow


==Example==
==Example==
  create sign color=white bcolor=darkblue vmargin=40.0 hmargin=2.0 align=center shadow
  create sign "Building is FUN :D" color=white bcolor=blue vmargin=40.0 hmargin=2.0 align=center shadow





Revision as of 23:49, 24 July 2018

Sign
Vp sign example.png
Sign with example code applied
Build required 1
Version required 0.3.0


The sign command allows the user to create text on objects which are able to receive sign textures.

Usage

   sign ["text"] [color=] [bcolor=] [margin=] [vmargin=] [hmargin=] [align=] [shadow OR noshadow]

Arguments

Text
Text to render on the sign. If omitted, the contents of the description field is used for the text
Values: Text string within double-quotes (e.g. "This is a string")
Default: [contents of Description field]
Color
The foreground color of the sign text
Values: Color Names, Hexadecimal colors
Default: White
Bcolor
The background color of the sign
Values: Color Names, Hexadecimal colors
Default: Blue
Margin
The overall margin of the sign. Same as setting HMargin and VMargin to the same value
Values: Decimal numbers greater than 0.0
Default: 0.0
Vmargin
The space between the edge of the sign, and the top of the text
Values: Decimal numbers greater than 0.0
Default: 0.0
Hmargin
The space between the left/right edges of the sign, and the left/right edges of the text
Values: Decimal numbers greater than 0.0
Default: 0.0
Align
Controls the general anchor point of the text
Values: Left, Right, Center
Default: Center
Noshadow OR Shadow
Adds a 1 Pixel black shadow to the text
Default: Noshadow

Example

create sign "Building is FUN :D" color=white bcolor=blue vmargin=40.0 hmargin=2.0 align=center shadow


Object Scripting

Triggers:

ActivateAdoneBumpBumpendCreate

Commands:

AnimateAnimationAmbientCameraColorDiffuseFrameFramerateGroupLightMoveNameNoiseNormalmapOpacityPathPictureRotateSayShearScaleSignSolidSoundSpecularSpecularmapTeleportTeleportxTeleportxyzTextureUrlVisibleWeb