PFS Vision
Contents
[PFS] Vision
The [PFS] Vision system is a tool to increase your immersion while enforcing some view effect on your side, you will be able to:
- Blind using the sphere view technology to limit the view distance
- Change others avatars into a simple silhouette past a distance
- Replace the world textures by an unique one
- Block the camera inside the sphere view
- Hide the location
- Block the start IM within a distance (RLVa only)
- Display the keyholder position and rotation on a radar
- Add an mask overlay (RLVa) or a mask HUD (RLV) with differents forms
- Adjust the transparency of the mask
- Adjust the main color of the mask (RLVa only)
- Lock the environnement with EEP settings
- Force the mouselook view
- lock the camera position
- limit the camera mouvement within a range
- focus the camera to look at a certain part of your keyholder
WARNING: Some people can be more sensitive to some visual effect which can trigger motion sickness or other type of seizures. use it wisely and respects people safewording!
1. Generalities
This object has been scripted in an unique way to make it flexible, versatile, accessible, modifiable and robust. In particular these themes has been defined as a new standard for today's and tomorrow PFS products and affiliate creators
1.1 RLV
As a viewer standard, RLV restrictions are filtered to the object UUID and if your object uses same restrictions for several functions, you may run into trouble and the result may look a way different than expected. Thay's why RLV, here, is managed to the script level. You can have several scripts triggering restrictions w/o any interactions between them. You can easily follows the object restrictions table from the RLV menu.
Both RLV and RLVa are supported here but for some special features like screen overlay an addition attachement is required for RLV users. Even if most of us uses RLVa viewers today we still need to make things compatible to previous standards.
1.2 Access
The menu access is build in an inovative way. As standard, everyone can access the menu, with different access levels. Access levels are:
- public
- locker
- keyholder
- selftouch
Depending on the lock state of the object, you may get different access levels (they are cumulable) which allows you to do things or not. The not allowed functions are strikethrough but the positive side is you can still read every parameter and setting, including the user.
The menu is still mono user but the keyholder has always the priority to access it.
You can access it using the command line over channel 7, just hit /7##vision to get access to the main menu of the object. Replace ## with the user 2 first letters of the user name.
The use of the API allows you to override the actual keyholder, this will help you to implement your own access list from wherever you want. You can implement "key grabbing" scripts as much you want they are asked one after the other. For more info look at the included public access script "plug.access.public".
1.3 Configurable
The object include a "config" notecard that allows you to modify it to your wishes. In our case here you can for example adds your own mask textures or your own world textures. There is no limitation except the script memory, consider you can have up to 20 masks textures and up to 20 world textures. For the world texture we prefer image file w/o alpha values.
1.4 API
Objects you cannot mod are no fun, that why you will find here an integrated API that will allows you to interact yourself with the object. Firstly created to manage the key grabbing for PFS, it is now documented and available to create for example: access plugins, interaction with other objects to enforce mask and world textures or your own HUD. More will come depending on the people and affiliate creators requests. To keep it easy and accessible to everyone the API works over JSON string shared on linked message channel 99.
1.5 Integrated help
To make is accessible and easy to use, the object menus have a "help" feature to stream in your chat window some general informations regarding the actual menu displayed to help you to understand what does every buttons.
1.6 Truekey
The only way to unlock the object is the use of the key held by the keyholder. In case you are stuck or the keyholder not showing back you can, if seted up previously, use the Truekey feature to get unlocked by everyone having the key password. You can access it, set it up and use it fromt he "Tools" menu.
2. Vision features
2.1 HUD
[PFS] Vision is locked
A mask is covering the display
A sphere is limitating the view
The camera is focused to look at the keyholder
All the world textures are overwritten
2.2 HUD radar mode
The radar mode is available from the "blind" menu. It helps the user to find the keyholder when blinded. the 
represents the user position and 
represents the keyholder position with the red triangle giving the direction where the keyholder is looking at.
The range of the radar is 40m with a logarithmic scale to give a better positionning when coming closer to the keyholder. This is particularly usefull for those enjoying activities like Silent blinded dressage.
- ⍰ HELP ⍰: Stream in your chat window the help for this menu.
- ⏏ EXIT ⏏: Close the menu and allows someone else to grab it.
- locked ✘: the HUD is not locked.
- locked ✔: the HUD is locked, you cannot detach it anymore.
- key ✘: the key has been taken, see the keyholder name.
- key ✔: the key is available and anyone can grab it.
- tools: sub menu for truekey, HUD controller...
- RLV: sub menu for RLV specifics features (if they are).
- timer: sub menu for RL/SL timer.
- blind: sub menu for all the blind functions like sphere, avatar, world texture, camera lock, location, start IM and radar.
- view: sub menu for all the view functions like mask, transparency, color and environnement.
- vision: sub menu for all the vision functions like mouselook, camera lock, camera limit and focus.
- ⍰ HELP ⍰: Stream in your chat window the help for this menu.
- ⇫ BACK ⇫: Go back to previous menu.
- ⏏ EXIT ⏏: Close the menu and allows someone else to grab it.
- TrueKey: Get a new TrueKey.
- set pw: set a new password number.
- use key: use your TrueKey to grab the key.
- get HUD: get the HUD to control this [PFS] Vision.
- ⇫ BACK ⇫: Go back to previous menu.
- ⏏ EXIT ⏏: Close the menu and allows someone else to grab it.
- list: Stream in your chat window all the active restrictions with the script name which is the source of the restriction. You may see same restriction for different scripts, this is all normal.
NOTE: When the timer runs out, the key is given back to the user. No one will be able to grab it except if they are some "key grabbing" plugin scripts installed.
- ⇫ BACK ⇫: Go back to previous menu.
- ⇦ PREVIOUS: previous page.
- NEXT ⇨: next page.
- ⍰ HELP ⍰: Stream in your chat window the help for this menu.
- stop: Stop the actual timer but don't give back the key to the user.
- RLtime ✔: Online timer mode. Switching timer mode is possible while running.
- hide ✔: The actual timer value and the added time triggered by the menu vuttons are hided to the user.
- +2min: Add 2 minutes to the actual timer value.
- +5min: Add 5 minutes to the actual timer value.
- +30min: Add 30 minutes to the actual timer value.
- +1h: Add 1 hour to the actual timer value.
- +3h: Add 3 hours to the actual timer value.
- +6h: Add 6 hours to the actual timer value.
- +12h: Add 12 hours to the actual timer value.
- +24h: Add 24 hours to the actual timer value.
- ⍰ HELP ⍰: Stream in your chat window the help for this menu.
- ⇫ BACK ⇫: Go back to previous menu.
- ⏏ EXIT ⏏: Close the menu and allows someone else to grab it.
- blind ✘: no sphere view, ▁: blurry, ▂: very thin, ▃: thin, ▆: medium, ▇: thick ▉: opaque. Works only in one way, to remove the actual sphere view, one has to step up all levels until coming back to the start.
- blind option: adjust the sphere settings (only for RLVa)
- pixel ✔: the colored sphere is replaced by a pixelisation effect depending on the 'blind" setting.
- black, D.gray, gray, L.gray or custom: Color the sphere with different settings.
- RGB: enter the R/G/B values for the custom color.
- avatar ✔: Turns all avatars past the distance to silouhettes and nametags are hidden, if the 'blind' mode is active the distance is adjusted the the sphere size otherwise a menu will allow you to adjust it.
NOTE: With Firestorm 6.6.3.67470 the avatars may just vanish from the screen! nice avatar eraser feature.
-world ✔: Makes the viewer ignore every texture in world, except those on the attachments worn by the avatars, as well as their skins and clothes. The materials are untouched. the gray texture can be replaced, see 'option world'.
- world option: adjust the texture used for the world.
- ⍰ HELP ⍰: Stream in your chat window the help for this menu.
- ⇫ BACK ⇫: Go back to previous menu.
- add: add a custom world texture to the set, format is texture UUID + name (8 chars max) no space no punctuation.
- rem: remove a custom world texture from the set.
- std gray: set the world texture to the standard gray.
- cow spot: set the world texture to cow spots.
- leather: set the world texture to leather.
- wood: set the world texture to wood.
- stone: set the world texture to stone.
- camera ✔: Force the camera to stay inside the sphere range, only available if the 'blind' is set (only RLVa).
- loc ✔: The user is unable to know where they are: the world map is hidden, the parcel and region name on the top menubar are hidden, they cannot create landmarks, nor buy land, nor see what land they have left after teleport, nor see the location in the About box, and even system and object messages are ofuscated if they contain the name of the region and/or the name of the parcel. In addition the user is unable to view the mini map and world map.
- startIM ✔: RLVa user can only start IMs to people who are on the same region they are between 0m and the distance. In case 'blind' is active the distance is set to the sphere range otherwise a menu will allow you to adjust it.
- startIM ✔: RLV user are prevented to start IMs, the distance modifier is not available!.
- ⍰ HELP ⍰: Stream in your chat window the help for this menu.
- ⇫ BACK ⇫: Go back to previous menu.
- ⏏ EXIT ⏏: Close the menu and allows someone else to grab it.
- mask ✔: Covers the entire screen with the specified texture (mask). The aspect ratio will be the aspect ration of the viewer’s world view and the mask will always render below all HUDs. RLVa user can only click throught the cuts outs if they are some. RLV user will get an additional HUD attached and the only way to touch world is the small pinhole in middle.
- list mask: define the mask to cover the user screen.
- ⍰ HELP ⍰: Stream in your chat window the help for this menu.
- ⇫ BACK ⇫: Go back to previous menu.
- add: Add a custom mask texture to the set, format is texture UUID + name (8 chars max) no space no punctuation. Best result with texture resolution 1024x512.
- rem: Remove a custom mask texture from the set.
- 2Bholes: Use a mask with 2 big sized holes.
- 2Mholes: Use a mask with 2 middle sized holes.
- 2Sholes: Use a mask with 2 small sized holes.
- blinders: Use a mask with the usual pony blinders to forces them to focus on the center.
- harness: Use a mask with the gag strap on the center.
- harnblind: Use a mask with the combinaison of gag harness and blinders.
- FullMask: Use a full mask covering all the screen.
-transparency: set the transparency value of the mask.
- ⇫ BACK ⇫: Go back to previous menu.
- 0%: the mask is fully opaque.
- 100%: the mask is fully transparent. The touch rules are still opeartive!
- -10%: decrease the transparency by 10%.
- 50%: Set the transparency to 50%.
- +10%: increase the transparency by 10%.
