Sign: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m OCD fix for bcolor default |
||
(11 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
{{feature|1|0.3.0| |Vp_sign_example.png|Sign with example code applied}} | |||
The '''sign''' command allows the user to create text on objects which are able to receive sign textures (rwx with one or more surfaces tagged 100, or group name "vp_sign" in OBJ and MD5Mesh models) | |||
{{Clear}} | |||
==Usage== | ==Usage== | ||
sign [ | '''sign''' [''"text"''] [''color=''] [''bcolor=''] [''margin=''] [''vmargin=''] [''hmargin=''] [''align=''] [''shadow OR noshadow''] [''name=''] [global] | ||
==Arguments== | ==Arguments== | ||
; Text Color : The foreground color of the sign text<br>'''Values:''' Color Names, Hexadecimal colors<br>'''Default:''' White | ; 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 | ||
; | ; Bcolor : The background color of the sign<br>'''Values:''' Color Names, Hexadecimal colors<br>'''Default:''' 0000C0 (Medium blue) | ||
; | ; Margin : The overall margin of the sign. Same as setting HMargin and VMargin to the same value<br>'''Values:''' Decimal numbers greater than 0.0<br>'''Default:''' 0.0 | ||
; | ; Vmargin : The space between the edge of the sign, and the top of the text<br>'''Values:''' Decimal numbers greater than 0.0<br>'''Default:''' 0.0 | ||
; Shadow : Adds a 1 Pixel black shadow to the text<br>''' | ; 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 | |||
; Noshadow OR Shadow : Adds a 1 Pixel black shadow to the text<br>'''Default:''' Noshadow | |||
; Name : The name of the object(s) to initiate the command on (see [[Name]] for more information)<br>'''Default:''' Current object only | |||
; Global : If set, this will cause a trigger (e.g. activate, adone) to initiate this command for all users have the object in view. Otherwise, the command will be initiated only for the user who activates the trigger<br>'''Default:''' Not set | |||
==Example== | ==Example== | ||
create sign color=white bcolor= | create sign "Building is FUN :D" color=white bcolor=blue vmargin=40.0 hmargin=2.0 align=center shadow | ||
Creates the sign visible on the example image on this page. | |||
create sign "Not clicked"; activate sign "Clicked" global | |||
Creates a sign with the text "Not clicked", which changes to "Clicked" if a users clicks it (for anyone who has it within view, due to the "global" flag being set). | |||
[[Category: | {{Build}} | ||
[[Category: Script commands]] |
Latest revision as of 22:40, 25 July 2018
Sign | ||
---|---|---|
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 (rwx with one or more surfaces tagged 100, or group name "vp_sign" in OBJ and MD5Mesh models)
Usage
sign ["text"] [color=] [bcolor=] [margin=] [vmargin=] [hmargin=] [align=] [shadow OR noshadow] [name=] [global]
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: 0000C0 (Medium 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 - Name
- The name of the object(s) to initiate the command on (see Name for more information)
Default: Current object only - Global
- If set, this will cause a trigger (e.g. activate, adone) to initiate this command for all users have the object in view. Otherwise, the command will be initiated only for the user who activates the trigger
Default: Not set
Example
create sign "Building is FUN :D" color=white bcolor=blue vmargin=40.0 hmargin=2.0 align=center shadow
Creates the sign visible on the example image on this page.
create sign "Not clicked"; activate sign "Clicked" global
Creates a sign with the text "Not clicked", which changes to "Clicked" if a users clicks it (for anyone who has it within view, due to the "global" flag being set).
|
|
Triggers: |
|
Commands: |
Animate • Animation • Ambient • Camera • Color • Diffuse • Frame • Framerate • Group • Light • Move • Name • Noise • Normalmap • Opacity • Path • Picture • Rotate • Say • Shear • Scale • Sign • Solid • Sound • Specular • Specularmap • Teleport • Teleportx • Teleportxyz • Texture • Url • Visible • Web |