House Scripts - Revision history

LockOn at 20:54, 3 December 2025

2025-12-03T20:54:00Z

← Older revision		Revision as of 20:54, 3 December 2025
Line 647:		Line 647:
	\| colspan="4" \|Turn the usable placeable into a waypoint where another placeable can bring characters to with the script hs_portal_used. The variable name should match exactly the <code>HS_PORTAL_TAG</code> defined on the other placeable. It shouldn't have more than 10 characters.		\| colspan="4" \|Turn the usable placeable into a waypoint where another placeable can bring characters to with the script hs_portal_used. The variable name should match exactly the <code>HS_PORTAL_TAG</code> defined on the other placeable. It shouldn't have more than 10 characters.
	\|}		\|}





	== Shackle Scripts ==		== Shackle Scripts ==
Line 665:		Line 661:
	\| OnDeath		\| OnDeath
	\| NA		\| NA
	\|-
	~~\| colspan="4" \|~~
	\|}		\|}

Line 682:		Line 676:
	\|}		\|}

			=== yasm_shackle ===
			{\| class="wikitable"
			\|+Full shackle system
			!Description !! Objects !! Event !! Variables
			\|-
			\| This system chains the prisoner to a shackle, allowing them freedom to move and emote whilst secured, but they are trapped within the length of the chain. A tether.
			To deploy the system in your house build simply put down a suitable placeable object, set it as usable and give it yasm_shackle as its heartbeat script.

			Whether or not you set a lock key determines how securely the prisoner is chained. With no key set the prisoner is released by just click/using the shackle. If a lock key is set the player needs to have an item with the required tag to unlock the prisoner. Keys tags work in the same manner as for doors & containers.

			The length of the chain can be controlled by setting a local variable, CHAIN_LENGTH (float), but this is optional and if omitted will default to 2.0

	~~Script: Placeable Used = shckle_p_talk~~		In game usage is very simple, the prisoner clicks the shackle and they are locked. Usage implies consent to the consequences. If the shackle has a lock then Unlock (rather than Use) to release the prisoner. Escaping is as simple as typing !ooc, and by the time you transition back with !ic the shackle will have reset itself.

	~~Trigger for~~ shackle ~~placeables~~.
	~~Slave Tether~~

	~~Discussion: http://sinfar~~.~~net/forum/viewtopic~~.~~php?f=64&t=1162~~


	~~Script: Placeable Heartbeat = yasm_shackle~~

	~~Script: Placeable Heartbeat = yasm_shackle~~

	~~Variable: CHAIN_LENGTH : Float~~

			You will notice that the system uses a trap mechanism, unfortunately the game engine spews a little bit of spam as players move in and out of the area of an active shackle/trap, sorry but that cant be muted. Just ignore the background noise and have fun emoting with the prisoner.
			\| Placeables
			\| OnHeartbeat
			\| CHAIN_LENGTH: Float
			! colspan="4" \|Notes
			\|-
			\| colspan="4" \|Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=1162
	Misc: Set PLC's Key to Owner's Key		Misc: Set PLC's Key to Owner's Key
			\|}

	~~This system chains the prisoner to a shackle, allowing them freedom to move and emote whilst secured, but they are trapped within the length of the chain. A tether.~~

	~~To deploy the system in your house build simply put down a suitable placeable object, set it as usable and give it yasm_shackle as its heartbeat script.~~

	Whether or not you set a lock key determines how securely the prisoner is chained. With no key set the prisoner is released by just click/using the shackle. If a lock key is set the player needs to have an item with the required tag to unlock the prisoner. Keys tags work in the same manner as for doors & containers.

	~~The length of the chain can be controlled by setting a local variable, CHAIN_LENGTH (float), but this is optional and if omitted will default to 2.0~~

	In game usage is very simple, the prisoner clicks the shackle and they are locked. Usage implies consent to the consequences. If the shackle has a lock then Unlock (rather than Use) to release the prisoner. Escaping is as simple as typing !ooc, and by the time you transition back with !ic the shackle will have reset itself.

	You will notice that the system uses a trap mechanism, unfortunately the game engine spews a little bit of spam as players move in and out of the area of an active shackle/trap, sorry but that cant be muted. Just ignore the background noise and have fun emoting with the prisoner.
	~~Stores~~

	~~Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5374~~


Line 724:		Line 712:
	Important Note: It is not advisable making garbage cans in areas with persistent storage, as item loss can occur when adding or removing persistent storage not properly tagged.		Important Note: It is not advisable making garbage cans in areas with persistent storage, as item loss can occur when adding or removing persistent storage not properly tagged.
	Turn Placeables State On/Off on use (with Sound Effects)		Turn Placeables State On/Off on use (with Sound Effects)
			Script: Placeable Used = g_plc_onoff
	Script: Placeable Used = g_plc_onoff		Script: Placeable Used = g_plc_onoff

Line 744:		Line 733:
	G_PLC_TURN_ON_SOUND : String		G_PLC_TURN_ON_SOUND : String
	VFX Heartbeat (with On/Off switch)		VFX Heartbeat (with On/Off switch)
			Script: Placeable Heartbeat = plcvfx_self
	Script: Placeable Heartbeat = plcvfx_self		Script: Placeable Heartbeat = plcvfx_self

Line 765:		Line 755:

	Variables: PLCVFX_SELF1, PLCVFX_SELF2, PLCVFX_SELF3, Etc…		Variables: PLCVFX_SELF1, PLCVFX_SELF2, PLCVFX_SELF3, Etc…
			Script: Placeable Used = plcvfx_switchoff
	Script: Placeable Used = plcvfx_switchoff		Script: Placeable Used = plcvfx_switchoff

Line 779:		Line 770:
	Variable: G_PLAYVFX : Integer		Variable: G_PLAYVFX : Integer
	VFX and SFX on Placable use		VFX and SFX on Placable use
			Script: Placeable Used = g_play_vfx_sound
	Script: Placeable Used = g_play_vfx_sound		Script: Placeable Used = g_play_vfx_sound

Line 797:		Line 789:

	When used a placeable sends an Image, Sound, or Video to web client.		When used a placeable sends an Image, Sound, or Video to web client.
			Script: Placeable Used = hs_use_wc_image
	Script: Placeable Used = hs_use_wc_image		Script: Placeable Used = hs_use_wc_image

Line 803:		Line 796:
	Sends an image to the web client of the player using the placeable.		Sends an image to the web client of the player using the placeable.

	Variable: HS_IMAGE_URL : ~~String~~		Variable: HS_IMAGE_URL : StringScript: hs_use_wc_image
			Placeable Used = hs_use_wc_sound

	Script: hs_use_wc_image		Script: hs_use_wc_image
Line 813:		Line 807:

	Variable: HS_SOUND_URL : String		Variable: HS_SOUND_URL : String
			Script: hs_use_wc_image
	Script: hs_use_wc_image		Script: hs_use_wc_image

Line 821:		Line 816:

	Variable: HS_MUSIC_URL : String		Variable: HS_MUSIC_URL : String
			Script: hs_use_wc_sound
	Script: hs_use_wc_sound		Script: hs_use_wc_sound

Line 831:		Line 827:

	Variable: HS_VIDEO_URL : String		Variable: HS_VIDEO_URL : String
			Script: hs_use_wc_video

	Script: hs_use_wc_video		Script: hs_use_wc_video

LockOn at 20:48, 3 December 2025

2025-12-03T20:48:29Z

@@ Line 652: / Line 652: @@
-Set a Placables Tag
+=== shckle_p_ondeath ===
-Script: Placeable Heartbeat = home_tag
+=== shckle_p_talk ===
-For security reasons Tags are usually removed or replaced when homes are uploaded, this script provides a safe tag for home builders to work with.
@@ Line 685: / Line 692: @@
 Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=1162
 Script: Placeable Heartbeat = yasm_shackle

LockOn at 20:40, 3 December 2025

2025-12-03T20:40:00Z

@@ Line 106: / Line 106: @@
 The placeable cannot be flagged as Plot. It must be able to take damage for this to work.
 |}
@@ Line 648: / Line 668: @@
 string GetHomeTagByID(string sOriginalTag, int nHomeID);
 Shackles (Bashable)
 Script: Placeable Death = shckle_p_ondeath

LockOn at 20:17, 3 December 2025

2025-12-03T20:17:04Z

← Older revision		Revision as of 20:17, 3 December 2025
Line 392:		Line 392:

	=== g_plc_used_turn ===		=== g_plc_used_turn ===
	Force		{\| class="wikitable"
			\|+Force turn a placeable
	~~Force~~		\|}

	{\| class="wikitable"		{\| class="wikitable"
	!Description !! Objects !! Event !! Variables		!Description !! Objects !! Event !! Variables
Line 628:		Line 629:


	~~== Rotate Placable on Use ==~~

	~~Script: Placeable Used = g_plc_used_turn~~

	~~Turns the used placeable by 30 degree, or the number of degree defined by the G_TURN_DEGREE variable.~~

	~~When it turns, you can make it play a sound defined by the variable G_TURN_SOUND.~~

	~~The placeable will be turned back after 30 seconds, or by the number of second that you set in the G_TURN_BACK_DELAY variable.~~

	~~Variables:~~

	~~G_TURN_BACK_DELAY : Integer~~

	~~G_TURN_DEGREE : Integer~~

	~~G_TURN_SOUND : String~~

LockOn at 19:55, 3 December 2025

2025-12-03T19:55:31Z

← Older revision		Revision as of 19:55, 3 December 2025
Line 358:		Line 358:
	\|}		\|}

	== ~~Elevations~~ ==		== Elevate and Rotate ==
	=== bi_p_elevate ===		=== bi_p_elevate ===
	{\| class="wikitable"		{\| class="wikitable"
	\|+~~ELevation~~ triggers		\|+Elevation triggers
	!Description !! Objects !! Event !! Variables		!Description !! Objects !! Event !! Variables
	\|-		\|-
Line 376:		Line 376:
	=== bi_p_elevatestep ===		=== bi_p_elevatestep ===
	{\| class="wikitable"		{\| class="wikitable"
	\|+~~ELevation~~ triggers		\|+Elevation triggers
	!Description !! Objects !! Event !! Variables		!Description !! Objects !! Event !! Variables
	\|-		\|-
Line 389:		Line 389:

	The <code>STEP</code> variable should be incremented for each step, starting at 1.		The <code>STEP</code> variable should be incremented for each step, starting at 1.
			\|}

			=== g_plc_used_turn ===
			Force

			Force
			{\| class="wikitable"
			!Description !! Objects !! Event !! Variables
			\|-
			\| Turns the used placeable by 30 degree, or the number of degree defined by the G_TURN_DEGREE variable.
			When it turns, you can make it play a sound defined by the variable G_TURN_SOUND.

			The placeable will be turned back after 30 seconds, or by the number of second that you set in the G_TURN_BACK_DELAY variable.
			\| Placeable
			\| OnUsed
			\| G_TURN_BACK_DELAY : Integer
			G_TURN_DEGREE : Integer

			G_TURN_SOUND : String
			\|-
			! colspan="4" \|Notes
			\|-
			\| colspan="4" \|
	\|}		\|}

Line 622:		Line 645:

	G_TURN_SOUND : String		G_TURN_SOUND : String



	Set a Placables Tag		Set a Placables Tag

Line 638:		Line 664:
	string GetHomeTagByID(string sOriginalTag, int nHomeID);		string GetHomeTagByID(string sOriginalTag, int nHomeID);
	Shackles (Bashable)		Shackles (Bashable)
			Script: Placeable Death = shckle_p_ondeath

	Script: Placeable Death = shckle_p_ondeath		Script: Placeable Death = shckle_p_ondeath

LockOn at 18:52, 3 December 2025

2025-12-03T18:52:06Z

← Older revision		Revision as of 18:52, 3 December 2025
Line 465:		Line 465:
	\|}		\|}

	== bi_p_cbar_hb ==		=== bi_p_cbar_hb ===
	{\| class="wikitable"		{\| class="wikitable"
	\|+Drinks Store		\|+Drinks Store
Line 518:		Line 518:
	\|}		\|}

	== g_onclickexamine ==		=== g_onclickexamine ===
	{\| class="wikitable"		{\| class="wikitable"
	\|+Examine a placeable		\|+Examine a placeable
Line 529:		Line 529:
	\|}		\|}

	== bi_p_force_emote ==		=== bi_p_force_emote ===
	{\| class="wikitable"		{\| class="wikitable"
	\|+Force Emote with a Placeable		\|+Force Emote with a Placeable
Line 545:		Line 545:
	\|}		\|}

	== hs_hb_makenboard ==		=== hs_hb_makenboard ===
	{\| class="wikitable"		{\| class="wikitable"
	\|+Noticeboards		\|+Noticeboards
Line 560:		Line 560:
	\|}		\|}

	== hs_tipjar ==		=== hs_tipjar ===
	'''Obtaining tips'''		'''Obtaining tips'''
	{\| class="wikitable"		{\| class="wikitable"

LockOn: spacing these out to fix for later.

2025-12-03T17:42:18Z

spacing these out to fix for later.

Show changes

LockOn: Moving around some of the scripts that were not labeled properly and have just been cut and pasted into the end of this page.

2025-12-03T17:36:19Z

Moving around some of the scripts that were not labeled properly and have just been cut and pasted into the end of this page.

@@ Line 128: / Line 128: @@
 If using APPEARANCE2 variables, do NOT use Armor, Body, Head or Gender variables. And similar - if you use any of those, do not use APPEARANCE2. APPEARANCE2 is acquired as a full string from a body or tailor model speaking the whole appearance rather than specific parts. Each PART can be max 1024 characters long. If your string exceeds that length, remove accessories/VFX.
 |}
@@ Line 736: / Line 762: @@
 Tailor NPCs
 Script: Placeable Close = pcplc_trash_cls

LockOn: Minor edits to

2025-06-15T21:30:28Z

Minor edits to

← Older revision		Revision as of 21:30, 15 June 2025
Line 164:		Line 164:
	Store tag is used to differentiate stores in the player home. Multiple stores with multiple tags are supported (for different vendors with different inventories).		Store tag is used to differentiate stores in the player home. Multiple stores with multiple tags are supported (for different vendors with different inventories).

	Mark up and mark down prices on items function based on a standardized formula~~, however~~ there is a hard cap of 1 million gold that can be collected on any ~~item sold~~. ~~The script will allow players to set a markup price over 1 million~~ gold~~, and sell at that price. However, all gold spent on~~ the ~~sale past that limit,~~ will be lost~~, and the store owner will only collect 1 million for the sale~~. Price carefully.		Mark up and mark down prices on items function based on a standardized formula.

			* price = item value * (x-1000) where x is the markup variable. (You can get the item value of any item by using the player tool on it.).

			However there is a hard cap of 10 million gold that can be collected in the chest at any one time. Any gold collected after the cap is hit will be lost. Price and monitor carefully.
	\|}		\|}

LockOn: Moved hs_tipjar out of the npc section

2025-06-15T20:52:56Z

Moved hs_tipjar out of the npc section

@@ Line 147: / Line 147: @@
 APPEARANCE_TYPE is the creature appearance index from the appearance.2da file. Use 6 for base human.
 |}
@@ Line 543: / Line 528: @@
 |-
 | colspan="4" |<code>HS_NOTICE_BOARD_TAG_SUFFIX</code> must be set to a unique tag of maximum 10, A-Z,0-9,_ characters.
 |}