Wobbly Life Mod SDK
 
Loading...
Searching...
No Matches
ModWobblyLife.ModCameraFocus Class Referenceabstract

CameraFocus used for custom cameras. More...

Inheritance diagram for ModWobblyLife.ModCameraFocus:
ModWobblyLife.Network.ModNetworkSubBehaviour ModWobblyLife.Network.IModNetworkSubBehaviour ModWobblyLife.ModCameraFocusRef ModWobblyLife.ModCameraFocusSimpleLookAt

Public Member Functions

void AssignCameraFocus (object cameraFocus)
 Internal use.
 
abstract void UpdateCamera (ModGameplayCamera camera, Transform cameraTransform)
 Called per frame to update the camera.
 
virtual bool IsFOVChangeAllowed ()
 Whether FOV changing is allowed.
 
virtual bool ShouldResetFOVOnFocus ()
 Whether should change FOV to default FOV on focus.
 
ModCameraFocusCallbacks GetInternalCallbacks ()
 Internal use.
 
- Public Member Functions inherited from ModWobblyLife.Network.ModNetworkSubBehaviour
void RegisterRPCs (ModNetworkObject networkObject)
 Called when you should register rpcs.
 
void NetworkStart (ModNetworkObject networkObject)
 Called when this object is ready on the network.
 
void NetworkPost (ModNetworkObject networkObject)
 Called after fully initalized the network.
 
GameObject GetGameObject ()
 Returns the gameobject of this object.
 
void RegisterRPCs (ModNetworkObject networkObject)
 Called when you should register rpcs.
 
void NetworkStart (ModNetworkObject networkObject)
 Called when this object is ready on the network.
 
void NetworkPost (ModNetworkObject networkObject)
 Called after fully initalized the network.
 
GameObject GetGameObject ()
 Returns the gameobject of this object.
 

Protected Member Functions

override void Awake ()
 
abstract void OnFocusCamera (ModPlayerController playerController)
 When a camera has focused on this camera focus.
 
abstract void OnUnfocusCamera (ModPlayerController playerController)
 When a camera has unfocused from this camera focus.
 
- Protected Member Functions inherited from ModWobblyLife.Network.ModNetworkSubBehaviour
virtual void Awake ()
 
virtual void Start ()
 
virtual void OnDestroy ()
 
virtual void ModAwake ()
 
virtual void ModStart ()
 
virtual void ModOnDestroy ()
 
virtual void ModRegisterRPCs (ModNetworkObject modNetworkObject)
 
virtual void ModNetworkStart (ModNetworkObject modNetworkObject)
 
virtual void ModNetworkPost (ModNetworkObject modNetworkObject)
 

Events

static Action< ModCameraFocusonPrepare
 Internal use.
 

Additional Inherited Members

- Public Attributes inherited from ModWobblyLife.Network.ModNetworkSubBehaviour
ModNetworkObject modNetworkObject
 

Detailed Description

CameraFocus used for custom cameras.

Member Function Documentation

◆ AssignCameraFocus()

void ModWobblyLife.ModCameraFocus.AssignCameraFocus ( object  cameraFocus)

Internal use.

Parameters
cameraFocus

◆ Awake()

override void ModWobblyLife.ModCameraFocus.Awake ( )
protectedvirtual

◆ GetInternalCallbacks()

ModCameraFocusCallbacks ModWobblyLife.ModCameraFocus.GetInternalCallbacks ( )

Internal use.

Returns

◆ IsFOVChangeAllowed()

virtual bool ModWobblyLife.ModCameraFocus.IsFOVChangeAllowed ( )
virtual

Whether FOV changing is allowed.

Returns

Reimplemented in ModWobblyLife.ModCameraFocusSimpleLookAt.

◆ OnFocusCamera()

abstract void ModWobblyLife.ModCameraFocus.OnFocusCamera ( ModPlayerController  playerController)
protectedpure virtual

When a camera has focused on this camera focus.

Parameters
playerController

Implemented in ModWobblyLife.ModCameraFocusRef, and ModWobblyLife.ModCameraFocusSimpleLookAt.

◆ OnUnfocusCamera()

abstract void ModWobblyLife.ModCameraFocus.OnUnfocusCamera ( ModPlayerController  playerController)
protectedpure virtual

When a camera has unfocused from this camera focus.

Parameters
playerController

Implemented in ModWobblyLife.ModCameraFocusRef, and ModWobblyLife.ModCameraFocusSimpleLookAt.

◆ ShouldResetFOVOnFocus()

virtual bool ModWobblyLife.ModCameraFocus.ShouldResetFOVOnFocus ( )
virtual

Whether should change FOV to default FOV on focus.

Returns

Reimplemented in ModWobblyLife.ModCameraFocusSimpleLookAt.

◆ UpdateCamera()

abstract void ModWobblyLife.ModCameraFocus.UpdateCamera ( ModGameplayCamera  camera,
Transform  cameraTransform 
)
pure virtual

Called per frame to update the camera.

Parameters
camera
cameraTransform

Implemented in ModWobblyLife.ModCameraFocusRef, and ModWobblyLife.ModCameraFocusSimpleLookAt.

Event Documentation

◆ onPrepare

Action<ModCameraFocus> ModWobblyLife.ModCameraFocus.onPrepare
static

Internal use.