Torque3D Documentation / _generateds / afxCameraPuppetData

afxCameraPuppetData

consoledoc.h

A datablock that specifies a Camera Puppet effect.

More...

Public Attributes

string

This field is like the effect-wrapper fields for specifying constraint sources, but here it specifies a target for the camera-puppet effect.

char

Specifies the networking model used for the camerapuppet effect. The effect can puppet just the server camera, just the client camera, or both.

Detailed Description

A datablock that specifies a Camera Puppet effect.

A Camera Puppet effect is used to control the position and orientation of the camera using the AFX constraint system. Camera Puppet effects are useful for creating small cut-scenes and can add a lot of visual drama to a spell or effectron effect.

Effective use of Camera Puppet effects require a fairly advanced understanding of how Torque cameras work in a server-client context. Care must be taken to prevent client cameras from drifting too far out of sync from the server camera. Otherwise, obvious discontinuities in the motion will result when the Camera Puppet ends and control is restored to the server camera. Scoping problems can also result if a client camera is moved to a location that is inconsistent with the scene scoping done by the server camera.

Often it is useful to manage camera controlling in an isolated effectron rather than directly incorporated into a magic-spell. This way the camera controlling effectron can target the specific client associated with the spellcaster. The spellcasting player observes the spell in a dramatic cut-scene-like fashion while other players continue to observe from their own viewing locations.

Public Attributes

string cameraSpec 

This field is like the effect-wrapper fields for specifying constraint sources, but here it specifies a target for the camera-puppet effect.

char networking 

Specifies the networking model used for the camerapuppet effect. The effect can puppet just the server camera, just the client camera, or both.

Possible values: $AFX::SERVER_ONLY, $AFX::CLIENT_ONLY, or $AFX::SERVER_AND_CLIENT.