prop_button

From Valve Developer Community
Jump to: navigation, search

prop_button is a point entity available in Vampire The Masquerade - Bloodlines Vampire The Masquerade - Bloodlines. A point entity that's used for a player-useable button. When used by the player, it moves to a pressed position or plays animation. Acts smiliar like a func_button.

Key Values


Targetname:
Name (???) <target_source>
The targetname that other entities refer to this entity by.
Start Hidden (targetname) <choices>
Don't spawn the entity while the script command didn't sent.
Value Description
0 Yes
1 No

Angles:
Pitch Yaw Roll (Y Z X) (angles) <angle>
This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.
Button Model (model) <model path>
Selects the button prop model.
Skin (skin) <integer>
Some models have multiple skins. Some models have multiple versions of their textures, called skins.

Set this to a number other than 0 to use that skin instead of the default.

Tip.pngTip:Hammer's model browser automatically updates this value if you use it to view different skins.
Skin Crossfade Time (crossfade_skin_time) <float>
The time that needed for cross-fading transition between model's skins given by output (in seconds).
Disable Shadows (disableshadows) <choices>
Disables shadow casing from this object.
Value Description
0 No
1 Yes
Parent Entity (parentname) <targetname>
The name of this entity's parent in the movement hierarchy. Entities with parents move with their parent.


Start Locked (locked) <choices>
Spawn in locked state?
Value Description
0 No
1 Yes
Use Icon (use_icon) <choices>
An icon that indicates unlocked state of this entity.
Value Description
0 None
31 Elevator button: Up
32 Elevator button: Down
28 Elevator button: B
29 Elevator button: G
21 Elevator button: 1
22 Elevator button: 2
23 Elevator button: 3
24 Elevator button: 4
25 Elevator button: 5
26 Elevator button: 6
27 Elevator button: 7
49 Elevator button: PH
12 Switch (wall)
64 Switch (power)
7 TV screen
15 Talk NPC (male)
14 Talk NPC (female)
51 Sewer Transition map
Locked Icon (locked_icon) <choices>
An icon that indicates locked state of this entity.
Value Description
Value Description
0 None
30 Elevator button: Locked
3 Lock
Sound Group (soundgroup) <choices>
The group of sounds relative to 'sound/usable/switches/<groupname>/<action>.wav' that specifies 'on/off' sounds.
Value Description
elevator_button Elevator Button
large_metal_lever Large Metal Lever
manhole_cover Manhole Cover
medium_metal_switch Medium Metal Switch
small_metal_switch Small Metal Switch
wall_light_switch Wall Light Switch
radio Radio
tv TV
Current State (cuttent_state) <choices>
Current button state.
Maximum States (max_states) <choices>
Maximum nubmer of button states.
Disable Receiving Shadows (disablereceiveshadows) <choices>
Disables shadows on object receiving from world and other objects.
Value Description
0 No
1 Yes
RenderMode (rendermode) <choices>
Used to set a non-standard rendering mode on this entity. See also 'FX Amount' and 'FX Color'.
Value Description
1 Color
2 Texture
3 Glow
4 Solid
5 Additive
6 Additive Fractional Frame
7 World Space Glow
8 Don't Render
Render Amount (0-255) (renderamt) <integer>
The FX amount is used by the selected Render Mode.
Render Color (R G B) (rendercolor) <color255>
The FX color is used by the selected Render Mode.


Inputs

Skin
Changes the model skin to the specified number.
SetSkin
Changes the model skin to the specified number (same as 'skin').
SetSkinFadeTime
Sets fade time between skin transitions.
FadeToSkin
Fades to specified skin (define number).
Lock
Lock the button, preventing it from functioning.
Unlock
Unlock the button, allowing it to function.
Press
Activate the button as if it was pressed.
ToggleLock
Toggles button state between locked and unlocked.
SetState
Sets button state.
SetParent
Changes the entity's parent in the movement hierarchy.
ClearParent
Removes this entity from the the movement hierarchy, leaving it free to move independently.


Alpha
Set the object's alpha (0 - 255)
Color
Set the object's color (R G B)


Outputs

OnPressed
Fired when the button is pressed.
OnPressedLocked
Fired when button pressed but has locked state.
OnSetState1
Fired when button goes to selected state.
OnSetState2
Fired when button goes to selected state.
OnSetState3
Fired when button goes to selected state.
OnSetState4
Fired when button goes to selected state.
OnSetState5
Fired when button goes to selected state.
OnSetState6
Fired when button goes to selected state.
OnSetState7
Fired when button goes to selected state.
OnSetState8
Fired when button goes to selected state.