Difference between revisions of "Camera Commands"

From Catznip
Jump to navigation Jump to search
Line 13: Line 13:
 
Changes the default camera offset by manipulating the '''CameraOffsetRearView''' debug setting.  
 
Changes the default camera offset by manipulating the '''CameraOffsetRearView''' debug setting.  
  
==={{RLVaCommand|setcam_focus||}}===
+
==={{RLVaCommand|setcam_focus|<object{{!}}agent{{!}}location>{{RLVaOptional|;distance[;direction]}}|{{RLVaCommandType|force}}}}===
 +
 
 +
 
 +
 
 
==={{RLVaCommand|setcam_focusoffset|{{RLVaOptional|{{RLVaParameter|vector3}}}}|{{RLVaCommandType|force}}}}===
 
==={{RLVaCommand|setcam_focusoffset|{{RLVaOptional|{{RLVaParameter|vector3}}}}|{{RLVaCommandType|force}}}}===
 
Changes the default camera focus offset by manipulating the '''FocusOffsetRearView''' debug setting.
 
Changes the default camera focus offset by manipulating the '''FocusOffsetRearView''' debug setting.

Revision as of 20:01, 5 June 2016

Camera manipulation commands follow the same concept as @setenv where a single object can exclusively lock control of the camera.


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.

Setting Camera values

@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<object|agent|location>[;distance[;direction]]=force

@setcam_focusoffset[<vector3>]=force

Changes the default camera focus offset by manipulating the FocusOffsetRearView debug setting.

@setcam_fov

@setcam_fovmin

@setcam_fovmax

@setcam_unlock

Camera Control Examples

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.

NOTE: if you're using these without @setcam then please restore the default manually after you're done; otherwise @setcam=y will take care of cleaning up and restore things back to the user's default

Change 3rd person camera position & viewpoint

@setcam_eyeoffset-2/-0.4/-0.2=force

@setcam_eyeoffset0.9/-0.7/0.2=force

Restore viewer default

@setcam_eyeoffset=force

@setcam_eyeoffset=force

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.