Difference between revisions of "Camera Commands"
| Line 3: | Line 3: | ||
Camera manipulation commands follow the same concept as {{RLVaCommand|setenv||}} where a single object can exclusively lock control of the camera. | Camera manipulation commands follow the same concept as {{RLVaCommand|setenv||}} where a single object can exclusively lock control of the camera. | ||
| − | ''' | + | '''Quick Tip :''' Basic camera position as detailed in [http://pennycow.blogspot.be/2011/07/matter-of-perspective.html Penny Patton's A Matter of perspective] can be done via the {{RLVaCommand|setcam_eyeoffset||}} and {{RLVaCommand|setcam_focusoffset||}} commands which adjust the '''CameraOffsetRearView''' and '''FocusOffsetRearView''' debug settings respectively. |
'''While we don't anticipate major changes the final implementation and behaviour of these commands isn't set in stone and subject to your feedback.''' | '''While we don't anticipate major changes the final implementation and behaviour of these commands isn't set in stone and subject to your feedback.''' | ||
| + | ==Compatibility with existing RLV commands== | ||
| + | Existing camera commands that don't fit the setcam_XXX family will currently (silently) translate to their new counterparts this is only a courtesy and these synonyms will be removed in a future release. Please use only @setcam_XXX in any of your products. | ||
| + | |||
==={{RLVaCommand|setcam||{{RLVaCommandType|ny}}}}=== | ==={{RLVaCommand|setcam||{{RLVaCommandType|ny}}}}=== | ||
| Line 11: | Line 14: | ||
Only one object can hold this behaviour at a given time (debug output will show "locked" as the failure message on subsequent attempts). When an object holds the lock, all camera commands from all other objects will be ignored; when the object releases the lock all other camera behaviours will be restored. | Only one object can hold this behaviour at a given time (debug output will show "locked" as the failure message on subsequent attempts). When an object holds the lock, all camera commands from all other objects will be ignored; when the object releases the lock all other camera behaviours will be restored. | ||
| − | ==={{RLVaCommand|setcam_eyeoffset||}}=== | + | ==={{RLVaCommand|setcam_eyeoffset|{{RLVaOptional|{{RLVaParameter|vector3}}}}|{{RLVaCommandType|force}}}}=== |
| + | Changes the default camera offset by manipulating the '''CameraOffsetRearView''' debug setting. | ||
| + | |||
==={{RLVaCommand|setcam_focus||}}=== | ==={{RLVaCommand|setcam_focus||}}=== | ||
| − | ==={{RLVaCommand|setcam_focusoffset||}}=== | + | ==={{RLVaCommand|setcam_focusoffset|{{RLVaOptional|{{RLVaParameter|vector3}}}}|{{RLVaCommandType|force}}}}=== |
| + | Changes the default camera focus offset by manipulating the '''FocusOffsetRearView''' debug setting. | ||
==={{RLVaCommand|setcam_fov||}}=== | ==={{RLVaCommand|setcam_fov||}}=== | ||
Revision as of 19:25, 5 June 2016
Camera manipulation commands follow the same concept as @setenv where a single object can exclusively lock control of the camera.
Quick Tip : Basic camera position as detailed in Penny Patton's A Matter of perspective can be done via the @setcam_eyeoffset and @setcam_focusoffset commands which adjust the CameraOffsetRearView and FocusOffsetRearView debug settings respectively.
While we don't anticipate major changes the final implementation and behaviour of these commands isn't set in stone and subject to your feedback.
Compatibility with existing RLV commands
Existing camera commands that don't fit the setcam_XXX family will currently (silently) translate to their new counterparts this is only a courtesy and these synonyms will be removed in a future release. Please use only @setcam_XXX in any of your products.
@setcam=<n|y>
Only one object can hold this behaviour at a given time (debug output will show "locked" as the failure message on subsequent attempts). When an object holds the lock, all camera commands from all other objects will be ignored; when the object releases the lock all other camera behaviours will be restored.
@setcam_eyeoffset[<vector3>]=force
Changes the default camera offset by manipulating the CameraOffsetRearView debug setting.
@setcam_focus
@setcam_focusoffset[<vector3>]=force
Changes the default camera focus offset by manipulating the FocusOffsetRearView debug setting.
