cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman....

Cinemachine

WelcometoCinemachine

Cinemachineisasuiteof‘smart’proceduralcameramoduleswhichallowyoutodefinetheshotandthey’lldynamicallyfollowyourdirection.

Setupshotswhichtrackandcomposemotioninrealtime,likeAIcameraoperators.Theproceduralnaturemakesthembug-resistantastheyalwaysworktomaketheshotbasedonyourdirection.That’sgreatforgameplay,butthey’realsoamazinglyfastforcutscenes.Changeananimation,avehiclespeed,groundterrain-whatever-andCinemachinewilldynamicallymaketheshot.Youcanusereallytelephotolensesandnothavetoupdatethecutsceneifthingschange.

TheBrainTheideaistotelltheUnitycamerawheretogoandwhattodoinresponsetogameplayandsceneevolution.Todothis,thefirststepistogivetheUnityCameraaCinemachineBrainbehaviour.Thinkofthatasthemoviedirector,whochoosesamongtheavailablecamerashotsfortheonethattellsthebeststoryatanygivenmoment.

ThenextstepistopopulateyourscenewithintelligentCinemachineVirtualCameraobjects.Thesecanbethoughtofasskilledcameramenwhoaregiveninstructionsaboutwhatgameobjectstotarget,andhowtofollowthem.Itisthebrain'sjobtomonitortheseandchoosethemostappropriateonetotrackatanygivenframe.

VirtualCamerasAvirtualcameraisnotacamera.Instead,itcanbethoughtofasacameracontroller,notunlikeacameraman.ItcandrivetheUnityCameraandcontrolitsposition,orientation,lenssettings,andPostProcessingeffects.EachVirtualCameraownsitsownCinemachineComponentPipeline,throughwhichyouprovidetheinstructionsfordynamicallytrackingspecificgameobjects.

Avirtualcameraisverylightweight,anddoesnorenderingofitsown.ItmerelytracksinterestingGameObjects,andpositionsitselfaccordingly.Atypicalgamecanhavedozensofvirtualcameras,

eachsetuptofollowaparticularcharacterorcaptureaparticularevent.

AVirtualCameracanbeinanyofthreestates:

Live:ThevirtualcameraisactivelycontrollingtheUnityCamera.Thevirtualcameraistrackingitstargetsandbeingupdatedeveryframe.Standby:Thevirtualcameraistrackingitstargetsandbeingupdatedeveryframe,butnoUnityCameraisactivelybeingcontrolledbyit.ThisisthestateofavirtualcamerathatisenabledinthescenebutperhapsatalowerprioritythantheLivevirtualcamera.Disabled:Thevirtualcameraispresentbutdisabledinthescene.Itisnotactivelytrackingitstargetsandsoconsumesnoprocessingpower.However,thevirtualcameracanbemadelivefromtheTimeline.

TheUnityCameracanbedrivenbyanyvirtualcamerainthescene.Thegamelogiccanchoosethevirtualcameratomakelivebymanipulatingthevirtualcameras'enabledflagsandtheirpriorities,basedongamelogic.

Inordertobedrivenbyavirtualcamera,theUnityCameramusthaveaCinemachineBrainbehaviour,whichwillselectthemosteligiblevirtualcamerabasedonitspriorityoronothercriteria,andwillmanageblending.

BlendingCameraBlendingisaconceptthatbringstheVirtualCamerasbeyondtheanalogyofacameraman.Itisessentiallyaninterpolationovertimeofonevirtualcamerapositionandstatetoanother.Ifyouthinkofvirtualcamerasascameramen,thenblendingisalittlelikeonecameramansmoothlypassingthecameratoanothercameraman.Youcanspecifythetimeoverwhichtoblend,aswellastheblendcurveshape.Notethatacameracutisjustazero-timeblend.

TheCinemachineBrainbehaviourholdstheinstructionsforblending.Thereyoucanspecifythedefaultblend(howvirtualcamerastranstionfromonebeinglivetoanother),andalsospecificoverridestothedefaultblendintheformofaninstructionlist:"whenthisvcamgoeslive,blendlikethis",or"whenbendingfromthisvcamtothatone,doitlikethat",andsoon.

GettingStartedThefirstthingtolookatistheCinemachineVirtualCamerabehaviour.ThatshouldleadyoutothepipelineofICinemachineComponentswhichserveasinstructionsforcontrollingthePosition,Orientation,andLensofthecamera.CreatesomeVirtualCamerasinyourscene,settheirtargets,andplaywiththeirsettingstoseewhattheydo.Alsohavealookatsomeoftheexamplescenesincludedwiththepackage.

TheAPIgenerallyreflectswhatyouseeintheinspectorforthebehavioursofthedifferentsortsofVirtualCamerasandtheircomponents.Havealookatthecorrespondingclasses,beginningwith:

CinemachineVirtualCamera

CinemachineBrain

CinemachineClearShot

CinemachineFreeLook

CinemachineCollider

CinemachineTransposer

CinemachineComposer

SeeAlsoOtherResourcesVersionHistory

VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service

Cinemachine

VersionHistory

Thetopicsinthissectiondescribethevariouschangesmadetothe[TODO:ProjectTitle]overthelifeoftheproject.

VersionHistorySelectaversionbelowtoseeadescriptionofitschanges.

Version2.0

Version2.1

SeeAlsoOtherResourcesWelcometoCinemachine

Cinemachine

Version2.0

Version2.0wasreleasedonJuly23,2017.

ChangesinThisReleaseThisisacompleteoverhaulofCinemachine1.0,andcontainsmanynewfeaturesandimplementations.

Unfortunatelyitwasnotpossibletomaintainback-compatibilitywithCinemachine1,andsoanyCinemachinecontentcreatedwithearlierversionswillhavetobere-createdusingthisversion.

PleaseseetheCinemachineForumforacompletelistofchangesinthisrelease.

Cinemachine

Version2.1

Version2.1wasreleasedonNov11,2017.

ChangesinThisReleasePostProcessingV2isnowsupported.

NewColliderimplementation.Curbfeelersaregone,replacedbyaclevercamera-repositioningalgorithmthatwilltrytopreservecameraheightordistancefromtarget(strategyisuser-selectable).

NewCinemachineConfiner:confineavirtualcameratoasimpleboundingvolumeorPolygonCollider2D.

NewFramingTransposer.Thisisaspecialtransposerthatwillrespectcompositionandframingrulesbymovingthecamerawithoutrotatingit.TakesonlyaFollowTarget(noLookAt-thisisimportant).DesignedforOrthographiccameras,butwillalsoworkforPerspectivecameras.IfFollowtargetisaCinemachineTargetGroup,thenwillalsoprovideGroupFramingoptions.

NewCinemachinePOVAimcomponent.Cameraaimisentirelycontrolledbyuser,using2inputaxes.

NewCinemachineMixingCamera.Driveacontinuousblendofupto8virtualcamerasfromtimelineorgamelogic.Createcomplexrigswithcustomblendsandexposethemasordinaryvcams.

NewCinemachineBlendListCamera.AminivcamsequencerthatprovidesaquickandeasywaytodoABcameramovesonthefly.

NewCinemachineDollyCartbehaviour,formovinganythingalongapath.Noneedtocreatedummyvcamsjustforthat.

NewCinemachineSmoothPathcomponent.YoucanuseitinsteadoftheoldCinemachinePath.ThedifferenceisthattheSmoothPathguaranteessecond-ordercontinuity,whichmeans

thattherewillneverbeanysuddencamerarotationchangesbakedintothepathtangents.Easiertouse,too:notangentstomessaroundwith(theygetautomaticallysetforsmoothness).

PathnowsupportsDistanceUnitsinadditiontoPathunits,makingiteasytocreatesteadymotion.

TrackedDolly:addedabilitytouseDistanceorPathunitsforpathposition.

TransposerandTrackedDolly:addedtargetangulardampingon3axes.

OrbitalTransposerandFreeLook:addedangulardampingandbindingmode,sameasTransposer.

OrbitalTransopserandfreelook:addedcheckboxtoinvertinputaxis.

Transposer,OrbitalTransposer,andFreeLook:addednewSimpleFollowbindingmode,whichwillfollowthetargetusingrotationasmuchaspossible,changingpositionaslittleaspossible.Likealazycameraman.

AddedIgnoreTimeScaleoptiontoBrain.Usefulforsnappycameraseveninslo-mo.

AddedLookaheadTimetocomposer.Composerwilllookatthepointwhereitestimatesthetargetwillbeatsometimeinthenearfuture.Thisgivesmuchmorenaturalframingofamovingtarget.

SmartUpdateissmarter:addedsupportforInterpolationwhentargetisanimatedbyphysicssystem.

Addedoff-buttonforSaveDuringPlay.

NoSaveDuringPlayforvcampriority,LookAtandFollowtargets,GroupTargetmembers.

AddedIsBlendingAPImethodtoStateDrivenCameraandClearShot.

TargetGroupnowhasauser-selectableupdatemethod.

TargetGroupnowrespectstheweightwhencomputingboundingbox,soit'spossibletograduallyaddorremovemembersbymanipulatingtheweight.

Clearshot:ifrandomize,thenre-randomizewheneveritbecomesactive.

ClearShot:defaultblendiscut.

ClearShotcreatemenu:addaColliderbydefault.

FollowZoom:min/maxFOVdefaultschangedto3/60.

Composerdampingrangeisnow0-20insteadof0-100.

OrbitalandFreeLook:HeadingBiascannowbeanimatedonthetimeline.

OrbitalandFreeLook:dampingnolongerinterfereswithcameraresponsetouserinput.Axismovementbypassesalldamping.

TrackedDolly:addedpathpositionoffsettoAuto-Dolly.Staysonthepath(unlikepathoffset,whichisbasedonthepathtangentandsocangooffthepath)

NoisecomponentinspectornowhasadropdownforProfilepresets,insteadofdirectlyallowingeditingoftheProfileasset.

AddedconceptofCinemachineExtension.Collider,confiner,PostProcessing,etcarenowExtensions.Theyareavailableviaadropdownatthebottomoftheinspectionforvirtualcameras.TheywillnolongerappearinthestandardComponentsmenu.

Time.timeScale=0isnowsupported.Pausingthegamewillalsopausethevirtualcameras.

HardConstrainthasbeensplitintotwosettings:DoNothingandHardLookAt/Follow.DoNothingwillleavethecamera'stransformalone,ignoringanytargetthatmayhavebeenset.

CinemachineBrainnolongerrequiresaCameracomponent.CanbeusedwithanyGameObject,makingitpossibletouseCinemachinetocontrolthetransformsofarbitraryobjects.

ImprovedlogicforAxisStateaccel/decel.Morerealisticbehaviour.

SaveDuringPlayobsoleteAPIfixfor2017.2.

FixedbuilderrorswhenbuildingforUWP.

ClearshotandSDC:don'tresetstateifdeactivated.

FreeLookdestroy-nomoreorphanrigs.

FixedstrangebuilderrorthatonlyshowedupinMonoDevelop.

FreeLookwasnotrespectingX-axisaccelanddecel.Headingspeedhadtobecrazyhigh.NowsameasOrbital(warning:mayhavetore-tunesettingsonexistingFreeLooks).

Recentertotargetheadingwasnotmovingsmoothlyinsomecircumstances.

Colliderraycastsnolongerhittriggers.

Noise:handlevariabledeltaTimegracefully.

State-Driven-Camera:don'tgenerateerrorswhenanimatedtargetisinactive.

Severaljitterandjudderissuesresolved.

Cinemachine

Namespaces

NamespacesNamespace Description

Cinemachine ThisnamespaceholdstheCoreCinemachinecode.

Cinemachine.Utility Cinemachinenon-domainutilitiesandUnityextensionsandhelpers

Cinemachine

CinemachineNamespace

ThisnamespaceholdstheCoreCinemachinecode.

Classes Class Description

CinemachineBasicMultiChannelPerlin AsapartoftheCinemachinePipelineimplementingtheNoisestage,thiscomponentaddsPerlinNoisetotheCamerastate,intheCorrectionoftheCameraState.iscreatedbyusingapredefinednoiseprofileasset.theshapeofthenoiseovertime.Youcanscalethisinamplitudeorintime,toproducefamilyofdifferentnoisesusingthesameprofile.

CinemachineBlend Describesablendbetween2CinemachineVirtualCameras,andholdsthetheblend.

CinemachineBlendDefinitionPropertyAttribute PropertyappliedtoCinemachineBlendDefinition.Usedforcustomdrawingintheinspector.

CinemachineBlenderSettings AssetthatdefinestherulesforblendingbetweenVirtualCameras.

CinemachineBlendListCamera Thisisavirtualcamera"manager"thatownsandmanagesacollectionVirtualCameras.cameragoeslive,thesechildvcamsareenabled,oneafteranother,holdingeachcameraforadesignatedtime.betweencamerasarespecified.Thelastcameraisheldindefinitely.

CinemachineBrain CinemachineBrainisthelinkbetweentheUnityCameraandtheCinemachineVirtualCamerasinthescene.monitorstheprioritystacktochoosethecurrentCamera,andblendwithanotherifnecessary.importantly,CamerastatetotheattachedUnityCamera.CinemachineBrainisalsotheplacewhererulesforblendingbetweenvirtualcamerasdefined.Camerablendingisaninterpolationovertimeofonevirtualcameratoanother.Ifyouthinkofvirtualcamerasascameramen,thenblendingisalittlelikeonecameramansmoothlypassingthecameratoanothercameraman.timeoverwhichtoblend,aswellastheblendcurveshape.thatacameracutisjustazero-timeblend.

CinemachineBrainBrainEvent EventwithaCinemachineBrainparameter

CinemachineBrainVcamEvent EventwithaICinemachineCameraparameter

CinemachineClearShot CinemachineClearShotisa"managercamera"thatownsandmanagesasetofCameragameObjectchildren.WhenLive,theClearShotwillcheckthechildren,andchoosetheonewiththebestqualityshotandmakeitLive.beaverypowerfultool.childcamerashaveCinemachineColliderextensions,theywillanalyzethescenefortargetobstructions,optimaltargetotheritems,andreporttheirassessmentofshotqualitybacktotheClearShotparent,whowillthenchoosethebestone.canusethistosetmulti-cameracoverageofascene,andbeassuredthataclearshotofalwaysbeavailable.childcamerashavethesameshotquality,theonewiththehighestprioritywillbechosen.YoucanalsodefinecustomblendsbetweentheClearShotchildren.

CinemachineCollider Anadd-onmoduleforCinemachineVirtualCamera

thatpost-processespositionofthevirtualcamera.Basedonthesuppliedsettings,theColliderwillattempttopreservethelineofsighttheLookAttargetofthevirtualcamerabymovingobjectsthatwillobstructtheview.Additionally,theCollidercanbeusedtoassesstheshotqualityandreportthisasafieldinthecameraState.

CinemachineComponentBase AnabstractrepresentationofamutatoractingonaCinemachineVirtualCamera

CinemachineComposer ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.Itsjobistoaimthecameraatthevcam'sLookAttargetobject,withoffsets,damping,andcompositionrules.composerdoesnotchangethecamera'sposition.panandtilttheis,inordertogetthedesiredframing.Tomovethecamera,youhavetousethevirtualcamera'sBodysection.

CinemachineConfiner Anadd-onmoduleforCinemachineVirtualCamerathatpost-processespositionofthevirtualcamera.Itwillconfinethevirtualpositiontothevolumespecified

intheBoundingVolumefield.

CinemachineCore AsingletonthatmanagescompletelistsofCinemachineBrainand,CinemachineVirtualCameras,andthepriorityqueue.servicestokeepingtrackofwhetherCinemachineVirtualCamerashaveeachframe.

CinemachineDollyCart ThisisaverysimplebehaviourthatconstrainsitstransformtoaCinemachinePath.usedtoanimateanyobjectsalongapath,orasaFollowtargetforCinemachineVirtualCameras.

CinemachineExtension BaseclassforaCinemachineVirtualCameraextensionmodule.HooksintotheCinemachinePipeline.

CinemachineExternalCamera Thiscomponentwillexposeanon-cinemachinecameratothecinemachinesystem,toparticipateinblends.itasacomponentalongsideanexistingUnityCameracomponent.

CinemachineFollowZoom Anadd-onmoduleforCinemachineVirtualCamerathatadjuststokeepthetargetobjectataconstantsizeonthescreen,regardlessofcameraandtarget

position.

CinemachineFramingTransposer ThisisaCinemachineComponentintheBodysectionofthecomponentpipeline.jobistopositionthecamerainafixedscreen-spacerelationshiptothevcam'sFollowtargetobject,withoffsetsanddamping.ThecamerawillbefirstmovedalongthecameraZaxisuntiltheFollowtargetthedesireddistancefromthecamera'sX-Yplane.camerawillthenXYplaneuntiltheFollowtargetisatthedesiredpointoncamera'sscreen.FramingTansposerwillonlychangethecamera'spositioninspace.Itwillnototherwiseaimthecamera.thiscomponenttoworkproperly,thevcam'sLookAttargetmustbenull.TheFollowtargetwilldefinewhatthecameraislookingat.IftheFollowtargetisaCinemachineTargetGroup,thenadditionalcontrolswillavailabletodynamicallyadjustthecamera’sviewinordertoframetheentiregroup.thiscomponentwasdesignedfororthographiccameras,itworksequallypersectivecamerasandcanbeusedin3Denvironments.

CinemachineFreeLook ACinemachineCamerageared

towardsa3rdpersoncameraexperience.arounditssubjectwiththreeseparatecamerarigsdefiningringsaroundthetarget.Eachrighasitsownradius,heightoffset,composer,andlenssettings.Dependingonthecamera'spositionalongthesplineconnectingthesethreerigs,thesesettingsareinterpolatedtogivethefinalcamerapositionandstate.

CinemachineGroupComposer ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.Itsjobistoaimthecameraatatargetobject,withconfigurableoffsets,damping,andcompositionrules.addition,ifthetargetisaCinemachineTargetGroup,thebehaviourwilladjusttheFOVandthecameradistancetoensurethattheentiregroupoftargetsisframedproperly.

CinemachineHardLockToTarget ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.ItsjobistoplacethecameraontheFollowTarget.

CinemachineHardLookAt ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.ItsjobistoaimthecamerahardattheLookAt

target.

CinemachineMixingCamera CinemachineMixingCameraisa"managercamera"thattakesonthestateoftheweightedaverageofthestatesofitschildvirtualcameras.ofslotsaremadeavailableforcameras,ratherthanadynamicarray.WedoitthiswayinordertosupportweightanimationfromtheTimeline.animatearrayelements.

CinemachineOrbitalTransposer ThisisaCinemachineComponentinthetheBodysectionofthecomponentpipeline.positionthecamerainavariablerelationshiptoathevcam'sFollowtargetobject,withoffsetsanddamping.typicallyusedtoimplementacamerathatfollowsitstarget.canacceptplayerinputfromaninputdevice,whichallowstheplayertodynamicallycontroltherelationshipbetweenthecameraandthetarget,ajoystick.TheOrbitalTransposerintroducestheconceptof__Heading__,whichisthedirectionthetargetismoving,andtheOrbitalTransposerwillattempttopositionthecamerainrelationshiptotheheading,whichisbydefaultdirectlybehindthetarget.

controlthedefaultrelationshipbyadjustingtheHeadingBiassetting.IfyouattachaninputcontrollertotheOrbitalTransposer,thentheplayercanalsothecamerapositionsitselfinrelationtothetargetheading.Thisallowsthecameratomovetoanyspotonanorbitaroundthetarget.

CinemachinePath Definesaworld-spacepath,consistingofanarrayofwaypoints,eachofwhichhasposition,tangent,androllsettings.Bezierinterpolationperformedbetweenthewaypoints,togetasmoothandcontinuouspath.

CinemachinePathBase Abstractbaseclassforaworld-spacepath,cameradollytrack.

CinemachinePathBaseAppearance Thisclassholdsthesettingsthatcontrolhowthepathintheeditorsceneview.pathisnotvisibleinthegameview

CinemachinePipeline InternalcontainerforCinemachineComponentBase.Doesnothingbutcontain.

CinemachinePOV ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.Itsjobistoaimthe

camerainresponsetotheuser'smouseorjoystickinput.composerdoesnotchangethecamera'sposition.panandtilttheis,inordertogetthedesiredframing.Tomovethecamera,youhavetousethevirtualcamera'sBodysection.

CinemachineSmoothPath Definesaworld-spacepath,consistingofanarrayofwaypoints,eachofwhichhaspositionandrollsettings.interpolationbetweenthewaypoints,togetasmoothandcontinuouspath.Thepathwillpassthroughallwaypoints,and(unlikeCinemachinePath)firstsecondordercontinuityisguaranteed

CinemachineStateDrivenCamera Thisisavirtualcamera"manager"thatownsandmanagesacollectionVirtualCameras.vcamsaremappedtoindividualstatesinananimationstatemachine,allowingyoutoassociatespecificvcamstospecificanimationstates.thatstateisactiveinthestatemachine,thenthecamerawillbeactivated.candefinecustomblendsandtransitionsbetweenchildcameras.Inordertousethisbehaviour,youmusthavean

animatedtarget(i.e.anobjectanimatedwithastatemachine)todrivethebehaviour.

CinemachineTargetGroup Definesagroupoftargetobjects,eachwitharadiusandaweight.Theweightisusedwhencalculatingtheaveragepositionofthetargetgroup.Higher-weightedmembersofthegroupwillcountmore.boundingboxiscalculatedbytakingthememberpositions,weight,andradiiintoaccount.

CinemachineTrackedDolly ACinemachineVirtualCameraBodycomponentthatconstrainscameramotionCinemachinePath.canmovealongthepath.behaviourcanoperateintwomodes:manualpositioning,andAuto-Dollypositioning.Manualmode,thecamera'spositionisspecifiedbyanimatingthePathPositionfield.InAuto-Dollymode,thePathPositionfieldisanimatedautomaticallyeveryframebyfindingthepositiononthepaththat'sclosesttothevirtualcamera'sFollowtarget.

CinemachineTransposer ThisisaCinemachineComponentintheBodysectionofthecomponentpipeline.Itsjobistopositionthecamerainafixedrelationshiptothevcam'sFollow

withoffsetsanddamping.Tansposerwillonlychangethecamera'spositioninspace.willnotre-orientorotherwiseaimthecamera.needtoinstructAimsectionofitspipeline.

CinemachineVirtualCamera ThisbehaviourisintendedtobeattachedtoanemptyTransformGameObject,VirtualCamerawithintheUnityscene.TheVirtualCamerawillanimateitsTransformaccordingtotherulescontainedCinemachineComponentpipeline(Aim,Body,andNoise).WhenthevirtualtheUnitycamerawillassumethepositionandorientationthevirtualcamera.cameraisnotacamera.Instead,itcanbethoughtofasacameracontroller,cameraman.ItcandrivetheUnityCameraandcontrolitsposition,orientation,lenssettings,andPostProcessingeffects.EachVirtualCameraownsitsownCinemachineComponentPipeline,throughwhichyouprovidetheinstructionstrackingspecificgameobjects.virtualcameraisverylightweight,anddoesnorenderingofitsown.ItmerelytracksinterestingGameObjects,andpositionsitselfaccordingly.

Atypicalgameofvirtualcameras,eachsetuptofollowaparticularcharactercaptureaparticularevent.VirtualCameracanbeinanyofthreestates:virtualcameraisactivelycontrollingtheUnityCamera.Thevirtualcameraistrackingitstargetsandbeingupdatedeveryframe.***Standby**:ThevirtualcameraistrackingitstargetsandbeingupdatedbutnoUnityCameraisactivelybeingcontrolledbyit.ThisisstateofavirtualcamerathatisenabledinthescenebutperhapsatatheLivevirtualcamera.**Disabled**:Thevirtualcameraispresentbutdisabledinthescene.Itisnotactivelytrackingitstargetsandsoconsumesnoprocessingpower.However,virtualcameracanbemadelivefromtheTimeline.Cameracanbedrivenbyanyvirtualcamerainthescene.Thegamelogiccanchoosethevirtualcameratomakelivebymanipulatingthevirtualcameras'enabledflagsandtheirpriorities,basedongamelogic.Inordertobedrivenbyavirtualcamera,theUnityCameramusthaveaCinemachineBrainbehaviour,whichwillselectthemosteligiblevirtualcamerabasedonitspriority

criteria,andwillmanageblending.

CinemachineVirtualCameraBase BaseclassforaMonobehaviourthatrepresentsaVirtualCamerawithintheUnityscene.intendedtobeattachedtoanemptyTransformGameObject.InheritedclassescanbeeitherstandalonevirtualcamerassuchasCinemachineVirtualCamera,ormeta-camerassuchasCinemachineClearShotorCinemachineFreeLook.CinemachineVirtualCameraBaseexposesaPriorityproperty.Whenthebehaviourisinthegame,theVirtualCameraisautomaticallyplacedinaqueuemaintainedbythestaticCinemachineCoresingleton.Thequeueissortedbypriority.WhenaUnitycameraisequippedwithaCinemachineBrainbehaviour,thebrainwillchoosethecameraattheheadofthequeue.havemultipleUnitycameraswithCinemachineBrainbehaviours(sayinasplit-screencontext),thenyoucanfilterthequeuebysettingthecullingflagsonthevirtualcameras.cullingmaskoftheCamerawillthenactasafilterforthebrain.thereisnothingthatpreventsavirtualcamerafromcontrollingmultipleUnitycameras

simultaneously.

DocumentationSortingAttribute Atrtributetocontroltheautomaticgenerationofdocumentation.

LensSettingsPropertyAttribute PropertyappliedtoLensSettings.drawingintheinspector.

NoiseSettings Thisisanassetthatdefinesanoiseprofile.theshapeofthenoiseasafunctionoftime.arbitrarilycomplexshapesbycombiningdifferentbaseperlinnoisefrequenciesatdifferentamplitudes.amplitudesshouldbechosenwithcare,toensureaninterestingnoisequalitythatisnotobviouslyrepetitive.mathematicalside-note,anyarbitraryperiodiccurvecanbebrokendownintoafixed-amplitudesine-wavesaddedtogether.fourierdecomposition,basisofmuchsignalprocessing.Itdoesn'treallyhavemuchtodowiththisasset,butit'ssuperinteresting!

NoSaveDuringPlayAttribute Suppressesplay-mode-saveforafield.Useitifthecalseehas[SaveDuringPlay]therearefieldsintheclassthatshouldn'tbesaved.

SaveDuringPlayAttribute Invokeplay-mode-saveforaclass.Thisclass'sfieldswillbescanneduponexitingplaymode,anditspropertyvalueswillbeappliedtothesceneobject.ThisisastopgapmeasurethatwillbecomeobsoleteonceUnityimplementsplay-mode-saveinamoregeneralway.

Structures Structure Description

AxisState Axisstatefordefiningtoreacttoplayerinput.Thesettingsherecontroltheresponsivenessoftheaxistoplayerinput.

CameraState TheoutputoftheCinemachineengineforaspecificvirtualcamera.informationinthisstructcanbeblended,andprovideswhatisneededtocalculateanappropriatecameraposition,orientation,andlenssetting.RawvaluesarewhattheCinemachine

behavioursgenerate.Thecorrectionchannelholdsperturbationstotherawvalues-e.g.noiseorsmoothing,orobstacleavoidancecorrections.Coirrectionsarenotconsideredwhenmakingtime-basedcalculationssuchasdamping.TheFinalpositionandorientationisthecominationoftherawvaluesandcorrections.

CameraStateCustomBlendable Opaquestructurerepresentextrablendablestuffanditsweight.Thebasesystemignoresthisdata-itisintendedforextensionmodules

CinemachineBlendDefinition DefinitionofaCamerablend.structholdstheinformationnecessarytogenerateasuitableAnimationCurveforaCinemachineBlend.

CinemachineBlenderSettingsCustomBlend ContainerspecifyinghowtwospecificCinemachineVirtualCamerasblendtogether.

CinemachineBlendListCameraInstruction ThisrepresentsasingleentryintheinstrunctionlistoftheBlendListCamera.

CinemachineFreeLookOrbit DefinestheheightandradiusoftheRigorbit

CinemachineOrbitalTransposerHeading Howthe"forward"directionisdefined.Orbitaloffsetisinrelationtotheforwarddirection.

CinemachineOrbitalTransposerRecentering Controlshowautomaticorbitrecenteringoccurs

CinemachinePathWaypoint Awaypointalongthepath

CinemachineSmoothPathWaypoint Awaypointalongthepath

CinemachineStateDrivenCameraInstruction ThisrepresentsasingleinstrunctiontotheStateDrivenCamera.Itassociatesanstatefromthestatemachinewithachild

VirtualCamera,andalsoholdsactivationtuningparameters.

CinemachineTargetGroupTarget Holdstheinformationthatrepresentsamemberofthegroup

CinemachineTrackedDollyAutoDolly Controlshowautomaticdollyingoccurs

LensSettings DescribestheFOVandclipplanesforacamera.ThisgenerallymirrorstheUnityCamera'slenssettings,andwillbeusedtodrivetheUnitycamerawhenthevcamisactive.

NoiseSettingsNoiseParams Describesthebehaviourforachannelofnoise

NoiseSettingsTransformNoiseParams Containsthebehaviourofnoiseforthenoisemoduleforall3cardinalaxesofthecamera

Interfaces Interface Description

ICinemachineCamera AnabstractrepresentationofavirtualcamerawhichliveswithintheUnityscene

Delegates Delegate

CinemachineCoreAxisInputDelegate

CinemachineFreeLookCreateRigDelegate

CinemachineFreeLookDestroyRigDelegate

CinemachineVirtualCameraCreatePipelineDelegate

CinemachineVirtualCameraDestroyPipelineDelegate

CinemachineVirtualCameraBaseOnPostPipelineStageDelegate

Enumerations Enumeration

CinemachineBlendDefinitionStyle

CinemachineBrainUpdateMethod

CinemachineColliderResolutionStrategy

CinemachineConfinerMode

CinemachineCoreStage

CinemachineCoreUpdateFilter

CinemachineDollyCartUpdateMethod

CinemachineFramingTransposerAdjustmentMode

CinemachineFramingTransposerFramingMode

CinemachineGroupComposerAdjustmentMode

CinemachineGroupComposerFramingMode

CinemachineOrbitalTransposerHeadingHeadingDefinition

CinemachinePathBasePositionUnits

CinemachineTargetGroupPositionMode

CinemachineTargetGroupRotationMode

CinemachineTargetGroupUpdateMethod

CinemachineTrackedDollyCameraUpMode

CinemachineTransposerBindingMode

DocumentationSortingAttributeLevel

Cinemachine

AxisStateStructure

Axisstatefordefiningtoreacttoplayerinput.Thesettingsherecontroltheresponsivenessoftheaxistoplayerinput.

Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)

Syntax

TheAxisStatetypeexposesthefollowingmembers.

Constructors Name Description

AxisState Constructorwithspecificvalues

Methods Name Description

SetThresholds Setstheconstraintsbywhichthisaxiswilloperateon

Update Updatesthestateofthisaxis

[SerializableAttribute]

[DocumentationSortingAttribute(6.4f,DocumentationSortingAttribute

publicstructAxisState

CopyC# JavaScript

basedontheaxisdefinedbyAxisState.m_AxisName

Validate CallfromOnValidate:Makesurethefieldsaresensible

Fields Name Description

m_AccelTime TheamountoftimeinsecondsittakestoacceleratetoMaxSpeedwiththesuppliedAxisatitsmaximumvalue

m_DecelTime Theamountoftimeinsecondsittakestodeceleratetheaxistozeroifthesuppliedaxisisinaneutralposition

m_InputAxisName ThenameofthisaxisasspecifiedinUnityInputmanager.Settingtoanemptystringwilldisabletheautomaticupdatingofthisaxis

m_InputAxisValue Thevalueoftheinputaxis.Avalueof0meansnoinputYoucandrivethisdirectlyfromacustominputsystem,oryoucansettheAxisNameandhavethevaluedrivenbytheinternalInputManager

m_InvertAxis Ifchecked,thentherawvalue

oftheinputaxiswillbeinvertedbeforeitisused.

m_MaxSpeed Howfasttheaxisvaluecantravel.Increasingthisnumbermakesthebehaviourmoreresponsivetojoystickinput

Value Thecurrentvalueoftheaxis

SeeAlsoReferenceCinemachineNamespace

Cinemachine

AxisStateConstructor

Constructorwithspecificvalues

Syntax

Parameters

maxSpeedType:SystemSingle[Missing<paramname="maxSpeed"/>documentationfor"M:Cinemachine.AxisState.#ctor(System.Single,System.Single,System.Single,System.Single,System.String,System.Boolean)"]

accelTimeType:SystemSingle[Missing<paramname="accelTime"/>documentationfor"M:Cinemachine.AxisState.#ctor(System.Single,System.Single,System.Single,System.Single,System.String,System.Boolean)"]

decelTimeType:SystemSingle[Missing<paramname="decelTime"/>documentationfor"M:Cinemachine.AxisState.#ctor(System.Single,System.Single,System.Single,System.Single,System.String,System.Boolean)"]

publicAxisState(

floatmaxSpeed,

floataccelTime,

floatdecelTime,

floatval,

stringname,

boolinvert

CopyC# JavaScript

Type:SystemSingle[Missing<paramname="val"/>documentationfor"M:Cinemachine.AxisState.#ctor(System.Single,System.Single,System.Single,System.Single,System.String,System.Boolean)"]

nameType:SystemString[Missing<paramname="name"/>documentationfor"M:Cinemachine.AxisState.#ctor(System.Single,System.Single,System.Single,System.Single,System.String,System.Boolean)"]

invertType:SystemBoolean[Missing<paramname="invert"/>documentationfor"M:Cinemachine.AxisState.#ctor(System.Single,System.Single,System.Single,System.Single,System.String,System.Boolean)"]

SeeAlsoReferenceAxisStateStructureCinemachineNamespace

Cinemachine

AxisStateMethods

SetThresholds Setstheconstraintsbywhichthisaxiswilloperateon

Update UpdatesthestateofthisaxisbasedontheaxisdefinedbyAxisState.m_AxisName

Validate CallfromOnValidate:Makesurethefieldsaresensible

Cinemachine

AxisStateSetThresholdsMethod

Setstheconstraintsbywhichthisaxiswilloperateon

Syntax

Parameters

minValueType:SystemSingleThelowestvaluethisaxiscanachieve

maxValueType:SystemSingleThehighestvaluethisaxiscanachieve

wrapAroundType:SystemBooleanIftrue,valuescommandedgreaterthanmMaxValueorlessthanmMinValuewillwraparound.Iffalse,thevaluewillbeclampedwithintherange.

SeeAlsoReferenceAxisStateStructure

publicvoidSetThresholds(

floatminValue,

floatmaxValue,

boolwrapAround

CopyC# JavaScript

Cinemachine

AxisStateUpdateMethod

UpdatesthestateofthisaxisbasedontheaxisdefinedbyAxisState.m_AxisName

Syntax

Parameters

deltaTimeType:SystemSingleDeltatimeinseconds

ReturnValueType:BooleanReturnstrueifthisaxis'inputwasnon-zerothisUpdate,flaseotherwise

publicboolUpdate(

floatdeltaTime

CopyC# JavaScript

Cinemachine

AxisStateValidateMethod

CallfromOnValidate:Makesurethefieldsaresensible

Syntax

publicvoidValidate()

CopyC# JavaScript

Cinemachine

AxisStateFields

m_AccelTime TheamountoftimeinsecondsittakestoacceleratetoMaxSpeedwiththesuppliedAxisatitsmaximumvalue

m_DecelTime Theamountoftimeinsecondsittakestodeceleratetheaxistozeroifthesuppliedaxisisinaneutralposition

m_InputAxisName ThenameofthisaxisasspecifiedinUnityInputmanager.Settingtoanemptystringwilldisabletheautomaticupdatingofthisaxis

m_InputAxisValue Thevalueoftheinputaxis.Avalueof0meansnoinputYoucandrivethisdirectlyfromacustominputsystem,oryoucansettheAxisNameandhavethevaluedrivenbytheinternalInputManager

m_InvertAxis Ifchecked,thentherawvalueoftheinputaxiswillbe

invertedbeforeitisused.

m_MaxSpeed Howfasttheaxisvaluecantravel.Increasingthisnumbermakesthebehaviourmoreresponsivetojoystickinput

Value Thecurrentvalueoftheaxis

Cinemachine

AxisStatem_AccelTimeField

TheamountoftimeinsecondsittakestoacceleratetoMaxSpeedwiththesuppliedAxisatitsmaximumvalue

Syntax

FieldValueType:Single

[TooltipAttribute("TheamountoftimeinsecondsittakestoacceleratetoMaxSpeedwiththesuppliedAxisatitsmaximumvalue")]

publicfloatm_AccelTime

CopyC# JavaScript

Cinemachine

AxisStatem_DecelTimeField

Theamountoftimeinsecondsittakestodeceleratetheaxistozeroifthesuppliedaxisisinaneutralposition

Syntax

[TooltipAttribute("Theamountoftimeinsecondsittakestodeceleratetheaxistozeroifthesuppliedaxisisinaneutralposition")]

publicfloatm_DecelTime

CopyC# JavaScript

Cinemachine

AxisStatem_InputAxisNameField

ThenameofthisaxisasspecifiedinUnityInputmanager.Settingtoanemptystringwilldisabletheautomaticupdatingofthisaxis

Syntax

FieldValueType:String

[FormerlySerializedAsAttribute("m_AxisName")]

[TooltipAttribute("ThenameofthisaxisasspecifiedinUnityInputmanager.Settingtoanemptystringwilldisabletheautomaticupdatingofthisaxis")]

publicstringm_InputAxisName

CopyC# JavaScript

Cinemachine

AxisStatem_InputAxisValueField

Thevalueoftheinputaxis.Avalueof0meansnoinputYoucandrivethisdirectlyfromacustominputsystem,oryoucansettheAxisNameandhavethevaluedrivenbytheinternalInputManager

Syntax

[NoSaveDuringPlayAttribute]

[TooltipAttribute("Thevalueoftheinputaxis.Avalueof0meansnoinput.Youcandrivethisdirectlyfromacustominputsystem,oryoucansettheAxisNameandhavethevaluedrivenbytheinternalInputManager")]

publicfloatm_InputAxisValue

CopyC# JavaScript

Cinemachine

AxisStatem_InvertAxisField

Ifchecked,thentherawvalueoftheinputaxiswillbeinvertedbeforeitisused.

Syntax

FieldValueType:Boolean

[TooltipAttribute("Ifchecked,thentherawvalueoftheinputaxiswillbeinvertedbeforeitisused")]

publicboolm_InvertAxis

CopyC# JavaScript

Cinemachine

AxisStatem_MaxSpeedField

Howfasttheaxisvaluecantravel.Increasingthisnumbermakesthebehaviourmoreresponsivetojoystickinput

Syntax

[TooltipAttribute("Themaximumspeedofthisaxisinunits/second")]

publicfloatm_MaxSpeed

CopyC# JavaScript

Cinemachine

AxisStateValueField

Thecurrentvalueoftheaxis

Syntax

[TooltipAttribute("Thecurrentvalueoftheaxis.")]

publicfloatValue

CopyC# JavaScript

Cinemachine

CameraStateStructure

TheoutputoftheCinemachineengineforaspecificvirtualcamera.Theinformationinthisstructcanbeblended,andprovideswhatisneededtocalculateanappropriatecameraposition,orientation,andlenssetting.RawvaluesarewhattheCinemachinebehavioursgenerate.Thecorrectionchannelholdsperturbationstotherawvalues-e.g.noiseorsmoothing,orobstacleavoidancecorrections.Coirrectionsarenotconsideredwhenmakingtime-basedcalculationssuchasdamping.TheFinalpositionandorientationisthecominationoftherawvaluesandtheircorrections.

Syntax

TheCameraStatetypeexposesthefollowingmembers.

Properties Name Description

CorrectedOrientation Orientationwithcorrectionapplied.

CorrectedPosition Positionwithcorrectionapplied.

Default Statewithdefaultvalues

publicstructCameraState

CopyC# JavaScript

FinalOrientation Orientationwithcorrectionanddutchapplied.Thisiswhatthefinalcameragets.

FinalPosition Positionwithcorrectionapplied.Thisiswhatthefinalcameragets.

HasLookAt ReturnstrueifthisstatehasavalidReferenceLookAtvalue.

Lens CameraLensSettings.

NumCustomBlendables Thenumberofcustomblendablesthatwillbeappliedtothecamera.Thebasesystemmanagesbutotherwiseignoresthisdata-itisintendedforextensionmodules

OrientationCorrection Orientationcorrection.Thiswillbeaddedtotheraworientation.Thisvaluedoesn'tgetfedbackintothesystemwhencalculatingthenextframe.Canbenoise,orsmoothing,orboth,orsomethingelse.

PositionCorrection Positioncorrection.Thiswillbeaddedtotherawposition.Thisvaluedoesn'tgetfedbackintothesystemwhen

calculatingthenextframe.Canbenoise,orsmoothing,orboth,orsomethingelse.

RawOrientation Raw(un-corrected)worldspaceorientationofthiscamera

RawPosition Raw(un-corrected)worldspacepositionofthiscamera

ReferenceLookAt Theworldspacefocuspointofthecamera.Whatthecamerawantstolookat.Thereisaspecialconstantdefinetorepresent"nothing".Becarefultocheckforthat(orchecktheHasLookAtproperty).

ReferenceUp Whichwayisup.Worldspaceunitvector.

ShotQuality Subjectiveestimationofhow"good"theshotis.Largervaluesmeanbetterquality.Defaultis1.

AddCustomBlendable Addacustomblendable

tothepotforeventualapplicationtothecamera.Thebasesystemmanagesbutotherwiseignoresthisdata-itisintendedforextensionmodules

GetCustomBlendable Getacustomblendablethatwillbeappliedtothecamera.Thebasesystemmanagesbutotherwiseignoresthisdata-itisintendedforextensionmodules

Lerp Intelligentlyblendthecontentsoftwostates.

kNoPoint Thisconstantrepresents"nopointinspace"or"nodirection".

Cinemachine

CameraStateProperties

CorrectedOrientation Orientationwithcorrectionapplied.

CorrectedPosition Positionwithcorrectionapplied.

Default Statewithdefaultvalues

FinalOrientation Orientationwithcorrectionanddutchapplied.Thisiswhatthefinalcameragets.

FinalPosition Positionwithcorrectionapplied.Thisiswhatthefinalcameragets.

HasLookAt ReturnstrueifthisstatehasavalidReferenceLookAtvalue.

Lens CameraLensSettings.

NumCustomBlendables Thenumberofcustomblendablesthatwillbeappliedtothecamera.Thebasesystemmanagesbutotherwise

ignoresthisdata-itisintendedforextensionmodules

OrientationCorrection Orientationcorrection.Thiswillbeaddedtotheraworientation.Thisvaluedoesn'tgetfedbackintothesystemwhencalculatingthenextframe.Canbenoise,orsmoothing,orboth,orsomethingelse.

PositionCorrection Positioncorrection.Thiswillbeaddedtotherawposition.Thisvaluedoesn'tgetfedbackintothesystemwhencalculatingthenextframe.Canbenoise,orsmoothing,orboth,orsomethingelse.

RawOrientation Raw(un-corrected)worldspaceorientationofthiscamera

RawPosition Raw(un-corrected)worldspacepositionofthiscamera

ReferenceLookAt Theworldspacefocuspointofthecamera.Whatthecamerawantstolookat.Thereisaspecialconstantdefinetorepresent"nothing".Becarefultocheckfor

that(orchecktheHasLookAtproperty).

ReferenceUp Whichwayisup.Worldspaceunitvector.

ShotQuality Subjectiveestimationofhow"good"theshotis.Largervaluesmeanbetterquality.Defaultis1.

SeeAlsoReferenceCameraStateStructureCinemachineNamespace

Cinemachine

CameraStateCorrectedOrientationProperty

Orientationwithcorrectionapplied.

Syntax

PropertyValueType:Quaternion

publicQuaternionCorrectedOrientation{get;}

CopyC# JavaScript

Cinemachine

CameraStateCorrectedPositionProperty

Positionwithcorrectionapplied.

Syntax

PropertyValueType:Vector3

publicVector3CorrectedPosition{get;}

CopyC# JavaScript

Cinemachine

CameraStateDefaultProperty

Statewithdefaultvalues

Syntax

PropertyValueType:CameraState

publicstaticCameraStateDefault{get;}

CopyC# JavaScript

Cinemachine

CameraStateFinalOrientationProperty

Orientationwithcorrectionanddutchapplied.Thisiswhatthefinalcameragets.

Syntax

publicQuaternionFinalOrientation{get;}

CopyC# JavaScript

Cinemachine

CameraStateFinalPositionProperty

Positionwithcorrectionapplied.Thisiswhatthefinalcameragets.

Syntax

publicVector3FinalPosition{get;}

CopyC# JavaScript

Cinemachine

CameraStateHasLookAtProperty

ReturnstrueifthisstatehasavalidReferenceLookAtvalue.

Syntax

PropertyValueType:Boolean

publicboolHasLookAt{get;}

CopyC# JavaScript

Cinemachine

CameraStateLensProperty

CameraLensSettings.

Syntax

PropertyValueType:LensSettings

publicLensSettingsLens{get;set;}

CopyC# JavaScript

Cinemachine

CameraStateNumCustomBlendablesProperty

Thenumberofcustomblendablesthatwillbeappliedtothecamera.Thebasesystemmanagesbutotherwiseignoresthisdata-itisintendedforextensionmodules

Syntax

PropertyValueType:Int32

publicintNumCustomBlendables{get;}

CopyC# JavaScript

Cinemachine

CameraStateOrientationCorrectionProperty

Orientationcorrection.Thiswillbeaddedtotheraworientation.Thisvaluedoesn'tgetfedbackintothesystemwhencalculatingthenextframe.Canbenoise,orsmoothing,orboth,orsomethingelse.

Syntax

publicQuaternionOrientationCorrection{get;set;}

CopyC# JavaScript

Cinemachine

CameraStatePositionCorrectionProperty

Positioncorrection.Thiswillbeaddedtotherawposition.Thisvaluedoesn'tgetfedbackintothesystemwhencalculatingthenextframe.Canbenoise,orsmoothing,orboth,orsomethingelse.

Syntax

publicVector3PositionCorrection{get;set;}

CopyC# JavaScript

Cinemachine

CameraStateRawOrientationProperty

Raw(un-corrected)worldspaceorientationofthiscamera

Syntax

publicQuaternionRawOrientation{get;set;}

CopyC# JavaScript

Cinemachine

CameraStateRawPositionProperty

Raw(un-corrected)worldspacepositionofthiscamera

Syntax

publicVector3RawPosition{get;set;}

CopyC# JavaScript

Cinemachine

CameraStateReferenceLookAtProperty

Theworldspacefocuspointofthecamera.Whatthecamerawantstolookat.Thereisaspecialconstantdefinetorepresent"nothing".Becarefultocheckforthat(orchecktheHasLookAtproperty).

Syntax

publicVector3ReferenceLookAt{get;set;}

CopyC# JavaScript

Cinemachine

CameraStateReferenceUpProperty

Whichwayisup.Worldspaceunitvector.

Syntax

publicVector3ReferenceUp{get;set;}

CopyC# JavaScript

Cinemachine

CameraStateShotQualityProperty

Subjectiveestimationofhow"good"theshotis.Largervaluesmeanbetterquality.Defaultis1.

Syntax

PropertyValueType:Single

publicfloatShotQuality{get;set;}

CopyC# JavaScript

Cinemachine

CameraStateMethods

AddCustomBlendable Addacustomblendabletothepotforeventualapplicationtothecamera.Thebasesystemmanagesbutotherwiseignoresthisdata-itisintendedforextensionmodules

GetCustomBlendable Getacustomblendablethatwillbeappliedtothecamera.Thebasesystemmanagesbutotherwiseignoresthisdata-itisintendedforextensionmodules

Lerp Intelligentlyblendthecontentsoftwostates.

Cinemachine

CameraStateAddCustomBlendableMethod

Addacustomblendabletothepotforeventualapplicationtothecamera.Thebasesystemmanagesbutotherwiseignoresthisdata-itisintendedforextensionmodules

Syntax

Parameters

bType:CinemachineCameraStateCustomBlendableThecustomblendabletoadd.Ifb.m_Customisthesameasanalready-addedcustomblendable,thentheywillbemergedandtheweightscombined.

publicvoidAddCustomBlendable(

CameraStateCustomBlendableb

CopyC# JavaScript

Cinemachine

CameraStateGetCustomBlendableMethod

Getacustomblendablethatwillbeappliedtothecamera.Thebasesystemmanagesbutotherwiseignoresthisdata-itisintendedforextensionmodules

Syntax

Parameters

indexType:SystemInt32Whichonetoget.Mustbeinrange[0...NumCustomBlendables)

ReturnValueType:CameraStateCustomBlendableThecustomblendableatthespecifiedindex.

publicCameraStateCustomBlendableGetCustomBlendable

intindex

CopyC# JavaScript

Cinemachine

CameraStateLerpMethod

Intelligentlyblendthecontentsoftwostates.

Syntax

Parameters

stateAType:CinemachineCameraStateThefirststate,correspondingtot=0

stateBType:CinemachineCameraStateThesecondstate,correspondingtot=1

tType:SystemSingleHowmuchtointerpolate.Internallyclampedto0..1

ReturnValueType:CameraStateLinearlyinterpolatedCameraState

SeeAlso

publicstaticCameraStateLerp(

CameraStatestateA,

CameraStatestateB,

floatt

CopyC# JavaScript

ReferenceCameraStateStructureCinemachineNamespace

Cinemachine

CameraStateFields

kNoPoint Thisconstantrepresents"nopointinspace"or"nodirection".

Cinemachine

CameraStatekNoPointField

Thisconstantrepresents"nopointinspace"or"nodirection".

Syntax

FieldValueType:Vector3

publicstaticVector3kNoPoint

CopyC# JavaScript

Cinemachine

CameraStateCustomBlendableStructure

Opaquestructurerepresentextrablendablestuffanditsweight.Thebasesystemignoresthisdata-itisintendedforextensionmodules

Syntax

TheCameraStateCustomBlendabletypeexposesthefollowingmembers.

CameraStateCustomBlendable Constructorwithspecificvalues

m_Custom Thecustomstuffthattheextentionmodulewillconsider

publicstructCustomBlendable

CopyC# JavaScript

m_Weight Theweightofthecustomstuff.Mustbe0...1

Cinemachine

CameraStateCustomBlendableConstructor

Syntax

Parameters

customType:ObjectThecustomstuffthattheextentionmodulewillconsider

weightType:SystemSingleTheweightofthecustomstuff.Mustbe0...1

SeeAlsoReferenceCameraStateCustomBlendableStructureCinemachineNamespace

publicCustomBlendable(

Objectcustom,

floatweight

CopyC# JavaScript

Cinemachine

CustomBlendableFields

TheCameraStateCustomBlendabletypeexposesthefollowingmembers.

m_Custom Thecustomstuffthattheextentionmodulewillconsider

m_Weight Theweightofthecustomstuff.Mustbe0...1

Cinemachine

CameraStateCustomBlendablem_CustomField

Thecustomstuffthattheextentionmodulewillconsider

Syntax

FieldValueType:Object

publicObjectm_Custom

CopyC# JavaScript

Cinemachine

CameraStateCustomBlendablem_WeightField

Theweightofthecustomstuff.Mustbe0...1

Syntax

publicfloatm_Weight

CopyC# JavaScript

Cinemachine

CinemachineBasicMultiChannelPerlinClass

AsapartoftheCinemachinePipelineimplementingtheNoisestage,thiscomponentaddsPerlinNoisetotheCamerastate,intheCorrectionchanneloftheCameraState.Thenoiseiscreatedbyusingapredefinednoiseprofileasset.Thisdefinestheshapeofthenoiseovertime.Youcanscalethisinamplitudeorintime,toproducealargefamilyofdifferentnoisesusingthesameprofile.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachineBasicMultiChannelPerlin

Syntax

TheCinemachineBasicMultiChannelPerlintypeexposesthefollowingmembers.

[DocumentationSortingAttribute(8f,DocumentationSortingAttribute

[AddComponentMenu("")]

[RequireComponent(typeof(CinemachinePipeline))]

[SaveDuringPlayAttribute]

publicclassCinemachineBasicMultiChannelPerlin:CinemachineComponentBase

CopyC# JavaScript

FollowTarget Returnstheownervcam'sFollowtarget.(InheritedfromCinemachineComponentBase.)

IsValid Trueifthecomponentisvalid,i.e.ithasanoisedefinitionandisenabled.(OverridesCinemachineComponentBaseIsValid.)

LookAtTarget Returnstheownervcam'sLookAttarget.(InheritedfromCinemachineComponentBase.)

Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheNoisestage(OverridesCinemachineComponentBaseStage.)

VcamState Returnstheownervcam'sCameraState.(InheritedfromCinemachineComponentBase.)

VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineComponentBase.)

MutateCameraState AppliesnoisetotheCorrectionchanneloftheCameraStateifthedeltatimeisgreaterthan0.Otherwise,doesnothing.(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)

OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.classimplementationdoesnothing.(InheritedfromCinemachineComponentBase

m_AmplitudeGain Gaintoapplytotheamplitudesdefinedinthesettingsasset.

m_FrequencyGain Scalefactortoapplytothefrequenciesdefinedinthesettingsasset.

m_NoiseProfile SerializedpropertyforreferencingaNoiseSettingsasset

SeeAlsoReference

CinemachineNamespaceCinemachineNoiseSettings

Cinemachine

CinemachineBasicMultiChannelPerlinProperties

IsValid Trueifthecomponentisvalid,i.e.ithasanoisedefinitionandisenabled.(OverridesCinemachineComponentBaseIsValid.)

Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheNoisestage(OverridesCinemachineComponentBaseStage.)

SeeAlsoReferenceCinemachineBasicMultiChannelPerlinClassCinemachineNamespace

Cinemachine

CinemachineBasicMultiChannelPerlinProperty

Trueifthecomponentisvalid,i.e.ithasanoisedefinitionandisenabled.

Syntax

publicoverrideboolIsValid{get;}

CopyC# JavaScript

Cinemachine

CinemachineBasicMultiChannelPerlinProperty

GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheNoisestage

Syntax

PropertyValueType:CinemachineCoreStage

publicoverrideCinemachineCoreStageStage{get;}

CopyC# JavaScript

Cinemachine

CinemachineBasicMultiChannelPerlinMethods

MutateCameraState AppliesnoisetotheCorrectionchanneloftheCameraStateifthedeltatimeisgreaterthan0.Otherwise,doesnothing.(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)

Cinemachine

CinemachineBasicMultiChannelPerlinMethod

AppliesnoisetotheCorrectionchanneloftheCameraStateifthedeltatimeisgreaterthan0.Otherwise,doesnothing.

Syntax

Parameters

curStateType:CinemachineCameraStateThecurrentcamerastate

deltaTimeType:SystemSingleHowmuchtoadvancetheperlinnoisegenerator.Noiseisonlyappliedifthisvalueisgreaterthanorequalto0

publicoverridevoidMutateCameraState(

refCameraStatecurState,

floatdeltaTime

CopyC# JavaScript

Cinemachine

CinemachineBasicMultiChannelPerlinFields

m_AmplitudeGain Gaintoapplytotheamplitudesdefinedinthesettingsasset.

m_FrequencyGain Scalefactortoapplytothefrequenciesdefinedinthesettingsasset.

m_NoiseProfile SerializedpropertyforreferencingaNoiseSettingsasset

Cinemachine

CinemachineBasicMultiChannelPerlinField

Gaintoapplytotheamplitudesdefinedinthesettingsasset.

Syntax

[TooltipAttribute("GaintoapplytotheamplitudesdefinedintheNoiseSettingsasset.1isnormal.Settingthisto0completelymutesthenoise.")]

publicfloatm_AmplitudeGain

CopyC# JavaScript

Cinemachine

Scalefactortoapplytothefrequenciesdefinedinthesettingsasset.

Syntax

[TooltipAttribute("ScalefactortoapplytothefrequenciesdefinedintheNoiseSettingsasset.1isnormal.Largermagnitudeswillmakethenoiseshakemorerapidly.")]

publicfloatm_FrequencyGain

CopyC# JavaScript

Cinemachine

SerializedpropertyforreferencingaNoiseSettingsasset

Syntax

FieldValueType:NoiseSettings

[HideInInspector]

[TooltipAttribute("TheassetcontainingtheNoiseProfile.Definethefrequenciesandamplitudestheretomakeacharacteristicnoiseprofile.Makeyourownorjustuseoneofthemanypresets.")]

[FormerlySerializedAsAttribute("m_Definition")]

publicNoiseSettingsm_NoiseProfile

CopyC# JavaScript

Cinemachine

CinemachineBlendClass

Describesablendbetween2CinemachineVirtualCameras,andholdsthecurrentstateoftheblend.

InheritanceHierarchySystemObjectCinemachineCinemachineBlend

Syntax

TheCinemachineBlendtypeexposesthefollowingmembers.

CinemachineBlend Constructablend

BlendCurve Thecurvethatdescribesthewaytheblendtransitionsovertimefromthefirstcameratothesecond.X-

publicclassCinemachineBlend

CopyC# JavaScript

axisistimeinsecondsoverwhichtheblendtakesplaceandYaxisisblendweight(0..1)

BlendWeight Thecurrentweightoftheblend.ThisisanevaluationoftheBlendCurveatthecurrenttimerelativetothestartoftheblend.0meanscamA,1meanscamB.

CamA Firstcameraintheblend

CamB Secondcameraintheblend

Description Textdescriptionoftheblend,fordebugging

Duration Durationinsecondsoftheblend.ThisisgivenreadfromtheBlendCurve.

IsComplete Trueifthetimerelativetothestartoftheblendisgreaterthanorequaltotheblendduration

IsValid Validitytestfortheblend.Trueifbothcamerasaredefined.

State ComputetheblendedCameraStateforthecurrenttimeintheblend.

TimeInBlend Thecurrenttimerelativetothestartoftheblend

UpdateCameraState Makesurethesourcecamerasgetupdated.

Uses DoestheblenduseaspecificCinemachineVirtualCamera?

Cinemachine

CinemachineBlendConstructor

Constructablend

Syntax

Parameters

aType:CinemachineICinemachineCameraFirstcamera

bType:CinemachineICinemachineCameraSecondcamera

curveType:AnimationCurveBlendcurve

durationType:SystemSingle[Missing<paramname="duration"/>documentationfor"M:Cinemachine.CinemachineBlend.#ctor(Cinemachine.ICinemachineCamera,Cinemachine.ICinemachineCamera,UnityEngine.AnimationCurve,System.Single,System.Single)"]

publicCinemachineBlend(

ICinemachineCameraa,

ICinemachineCamerab,

AnimationCurvecurve,

floatduration,

floatt

CopyC# JavaScript

Type:SystemSingleCurrenttimeinblend,relativetothestartoftheblend

SeeAlsoReferenceCinemachineBlendClassCinemachineNamespace

Cinemachine

CinemachineBlendProperties

BlendCurve Thecurvethatdescribesthewaytheblendtransitionsovertimefromthefirstcameratothesecond.X-axisistimeinsecondsoverwhichtheblendtakesplaceandYaxisisblendweight(0..1)

BlendWeight Thecurrentweightoftheblend.ThisisanevaluationoftheBlendCurveatthecurrenttimerelativetothestartoftheblend.0meanscamA,1meanscamB.

CamA Firstcameraintheblend

CamB Secondcameraintheblend

Description Textdescriptionoftheblend,fordebugging

Duration Durationinsecondsoftheblend.ThisisgivenreadfromtheBlendCurve.

IsComplete Trueifthetimerelativetothestartoftheblendisgreaterthanorequaltotheblendduration

IsValid Validitytestfortheblend.Trueifbothcamerasaredefined.

State ComputetheblendedCameraStateforthecurrenttimeintheblend.

TimeInBlend Thecurrenttimerelativetothestartoftheblend

Cinemachine

CinemachineBlendBlendCurveProperty

Thecurvethatdescribesthewaytheblendtransitionsovertimefromthefirstcameratothesecond.X-axisistimeinsecondsoverwhichtheblendtakesplaceandYaxisisblendweight(0..1)

Syntax

PropertyValueType:AnimationCurve

publicAnimationCurveBlendCurve{get;set;}

CopyC# JavaScript

Cinemachine

CinemachineBlendBlendWeightProperty

Thecurrentweightoftheblend.ThisisanevaluationoftheBlendCurveatthecurrenttimerelativetothestartoftheblend.0meanscamA,1meanscamB.

Syntax

publicfloatBlendWeight{get;}

CopyC# JavaScript

Cinemachine

CinemachineBlendCamAProperty

Firstcameraintheblend

Syntax

PropertyValueType:ICinemachineCamera

publicICinemachineCameraCamA{get;set;}

CopyC# JavaScript

Cinemachine

CinemachineBlendCamBProperty

Secondcameraintheblend

Syntax

publicICinemachineCameraCamB{get;set;}

CopyC# JavaScript

Cinemachine

CinemachineBlendDescriptionProperty

Textdescriptionoftheblend,fordebugging

Syntax

PropertyValueType:String

publicstringDescription{get;}

CopyC# JavaScript

Cinemachine

CinemachineBlendDurationProperty

Durationinsecondsoftheblend.ThisisgivenreadfromtheBlendCurve.

Syntax

publicfloatDuration{get;set;}

CopyC# JavaScript

Cinemachine

CinemachineBlendIsCompleteProperty

Trueifthetimerelativetothestartoftheblendisgreaterthanorequaltotheblendduration

Syntax

publicboolIsComplete{get;}

CopyC# JavaScript

Cinemachine

CinemachineBlendIsValidProperty

Validitytestfortheblend.Trueifbothcamerasaredefined.

Syntax

publicboolIsValid{get;}

CopyC# JavaScript

Cinemachine

CinemachineBlendStateProperty

ComputetheblendedCameraStateforthecurrenttimeintheblend.

Syntax

publicCameraStateState{get;}

CopyC# JavaScript

Cinemachine

CinemachineBlendTimeInBlendProperty

Thecurrenttimerelativetothestartoftheblend

Syntax

publicfloatTimeInBlend{get;set;}

CopyC# JavaScript

Cinemachine

CinemachineBlendMethods

UpdateCameraState Makesurethesourcecamerasgetupdated.

Uses DoestheblenduseaspecificCinemachineVirtualCamera?

Cinemachine

CinemachineBlendUpdateCameraStateMethod

Makesurethesourcecamerasgetupdated.

Syntax

Parameters

worldUpType:Vector3Defaultworldup.Individualvcamsmaymodifythis

deltaTimeType:SystemSingleTimeincrementusedforcalculatingtime-basedbehaviours(e.g.damping)

VisittheCinemachineForum

publicvoidUpdateCameraState(

Vector3worldUp,

floatdeltaTime

CopyC# JavaScript

https://unity3d.com/legal/terms-of-service

Cinemachine

CinemachineBlendUsesMethod

DoestheblenduseaspecificCinemachineVirtualCamera?

Syntax

Parameters

camType:CinemachineICinemachineCameraThecameratotest

ReturnValueType:BooleanTrueifthecameraisinvolvedintheblend

publicboolUses(

ICinemachineCameracam

CopyC# JavaScript

Cinemachine

CinemachineBlendDefinitionStructure

DefinitionofaCamerablend.ThisstructholdstheinformationnecessarytogenerateasuitableAnimationCurveforaCinemachineBlend.

Syntax

TheCinemachineBlendDefinitiontypeexposesthefollowingmembers.

CinemachineBlendDefinition Constructor

BlendCurve AnAnimationCurvespecifyingthe

publicstructCinemachineBlendDefinition

CopyC# JavaScript

interpolationdurationandvalueforthiscamerablend.Thetimeofthelastkeyframeisassumedtothebethedurationoftheblend.Y-axisvaluesmustbeinrange[0,1](internallyclampedwithinBlender)andtimemustbeinrangeof[0,+infinity)

m_Style Theshapeoftheblendcurve.

m_Time Theduration(inseconds)oftheblend

Cinemachine

CinemachineBlendDefinitionConstructor

Constructor

Syntax

Parameters

styleType:CinemachineCinemachineBlendDefinitionStyleTheshapeoftheblendcurve.

timeType:SystemSingleTheduration(inseconds)oftheblend

SeeAlsoReferenceCinemachineBlendDefinitionStructureCinemachineNamespace

publicCinemachineBlendDefinition(

CinemachineBlendDefinitionStylestyle,

floattime

CopyC# JavaScript

Cinemachine

CinemachineBlendDefinitionProperties

BlendCurve AnAnimationCurvespecifyingtheinterpolationdurationandvalueforthiscamerablend.Thetimeofthelastkeyframeisassumedtothebethedurationoftheblend.Y-axisvaluesmustbeinrange[0,1](internallyclampedwithinBlender)andtimemustbeinrangeof[0,+infinity)

Cinemachine

CinemachineBlendDefinitionBlendCurveProperty

AnAnimationCurvespecifyingtheinterpolationdurationandvalueforthiscamerablend.Thetimeofthelastkeyframeisassumedtothebethedurationoftheblend.Y-axisvaluesmustbeinrange[0,1](internallyclampedwithinBlender)andtimemustbeinrangeof[0,+infinity)

Syntax

PropertyValueType:AnimationCurve

publicAnimationCurveBlendCurve{get;}

CopyC# JavaScript

Cinemachine

CinemachineBlendDefinitionFields

m_Style Theshapeoftheblendcurve.

m_Time Theduration(inseconds)oftheblend

Cinemachine

CinemachineBlendDefinitionm_StyleField

Theshapeoftheblendcurve.

Syntax

FieldValueType:CinemachineBlendDefinitionStyle

[TooltipAttribute("Shapeoftheblendcurve")]

publicCinemachineBlendDefinitionStylem_Style

CopyC# JavaScript

Cinemachine

CinemachineBlendDefinitionm_TimeField

Theduration(inseconds)oftheblend

Syntax

[TooltipAttribute("Durationoftheblend,inseconds")]

publicfloatm_Time

CopyC# JavaScript

Cinemachine

CinemachineBlendDefinitionStyleEnumeration

Supportedpredefinedshapesfortheblendcurve.

Syntax

Members

Membername Value Description

Cut 0 Zero-lengthblend

EaseInOut 1 S-shapedcurve,givingagentleandsmoothtransition

EaseIn 2 Linearoutoftheoutgoingshot,andeasyintotheincoming

EaseOut 3 Easyoutoftheoutgoingshot,andlinearintotheincoming

publicenumStyle

CopyC# JavaScript

HardIn 4 Easyoutoftheoutgoing,andhardintotheincoming

HardOut 5 Hardoutoftheoutgoing,andeasyintotheincoming

Linear 6 Linearblend.Mechanical-looking.

Cinemachine

CinemachineBlendDefinitionPropertyAttributeClass

PropertyappliedtoCinemachineBlendDefinition.Usedforcustomdrawingintheinspector.

InheritanceHierarchySystemObjectSystemAttributePropertyAttributeCinemachineCinemachineBlendDefinitionPropertyAttribute

Syntax

TheCinemachineBlendDefinitionPropertyAttributetypeexposesthefollowingmembers.

CinemachineBlendDefinitionPropertyAttribute

SeeAlso

publicsealedclassCinemachineBlendDefinitionPropertyAttribute

CopyC# JavaScript

ReferenceCinemachineNamespace

Cinemachine

CinemachineBlendDefinitionPropertyAttributeConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineBlendDefinitionPropertyAttribute.#ctor"]

Syntax

SeeAlsoReferenceCinemachineBlendDefinitionPropertyAttributeClassCinemachineNamespace

publicCinemachineBlendDefinitionPropertyAttribute()

CopyC# JavaScript

Cinemachine

CinemachineBlenderSettingsClass

AssetthatdefinestherulesforblendingbetweenVirtualCameras.

InheritanceHierarchySystemObjectObjectScriptableObjectCinemachineCinemachineBlenderSettings

Syntax

TheCinemachineBlenderSettingstypeexposesthefollowingmembers.

CinemachineBlenderSettings

publicsealedclassCinemachineBlenderSettings:ScriptableObject

CopyC# JavaScript

GetBlendCurveForVirtualCameras Attemptstofindablendcurvewhichmatchesthetoandfromcamerasasspecified.Ifnomatchisfound,thefunctionreturnseitherthedefaultblendforthisBlenderorNULLdependingonthestatereturnDefaultOnNoMatch

kBlendFromAnyCameraLabel InternalAPIfortheinspectoreditopr:alabeltorepresentanycamera

m_CustomBlends ThearraycontainingexplicitlydefinedblendsbetweentwoVirtualCameras

SeeAlso

Cinemachine

CinemachineBlenderSettingsConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineBlenderSettings.#ctor"]

Syntax

SeeAlsoReferenceCinemachineBlenderSettingsClassCinemachineNamespace

publicCinemachineBlenderSettings()

CopyC# JavaScript

Cinemachine

CinemachineBlenderSettingsMethods

GetBlendCurveForVirtualCameras Attemptstofindablendcurvewhichmatchesthetoandfromcamerasasspecified.Ifnomatchisfound,thefunctionreturnseitherthedefaultblendforthisBlenderorNULLdependingonthestatereturnDefaultOnNoMatch

Cinemachine

CinemachineBlenderSettingsGetBlendCurveForVirtualCamerasMethod

Attemptstofindablendcurvewhichmatchesthetoandfromcamerasasspecified.Ifnomatchisfound,thefunctionreturnseitherthedefaultblendforthisBlenderorNULLdependingonthestateofreturnDefaultOnNoMatch.

Syntax

Parameters

fromCameraNameType:SystemStringThegameobjectnameofthefromcamera

toCameraNameType:SystemStringThegameobjectnameofthetocamera

defaultCurveType:AnimationCurveCurvetoreturnifnocurvefound.CanbeNULL.

publicAnimationCurveGetBlendCurveForVirtualCameras

stringfromCameraName,

stringtoCameraName,

AnimationCurvedefaultCurve

CopyC# JavaScript

ReturnValueType:AnimationCurve[Missing<returns>documentationfor"M:Cinemachine.CinemachineBlenderSettings.GetBlendCurveForVirtualCameras(System.String,System.String,UnityEngine.AnimationCurve)"]

Cinemachine

CinemachineBlenderSettingsFields

kBlendFromAnyCameraLabel InternalAPIfortheinspectoreditopr:alabeltorepresentanycamera

m_CustomBlends ThearraycontainingexplicitlydefinedblendsbetweentwoVirtualCameras

Cinemachine

CinemachineBlenderSettingskBlendFromAnyCameraLabelField

InternalAPIfortheinspectoreditopr:alabeltorepresentanycamera

Syntax

publicconststringkBlendFromAnyCameraLabel="**ANYCAMERA**"

CopyC# JavaScript

Cinemachine

CinemachineBlenderSettingsm_CustomBlendsField

ThearraycontainingexplicitlydefinedblendsbetweentwoVirtualCameras

Syntax

FieldValueType:CinemachineBlenderSettingsCustomBlend

[TooltipAttribute("ThearraycontainingexplicitlydefinedblendsbetweentwoVirtualCameras")]

publicCinemachineBlenderSettingsCustomBlend[]m_CustomBlends

CopyC# JavaScript

Cinemachine

CinemachineBlenderSettingsCustomBlendStructure

ContainerspecifyinghowtwospecificCinemachineVirtualCamerasblendtogether.

Syntax

TheCinemachineBlenderSettingsCustomBlendtypeexposesthefollowingmembers.

m_Blend

m_From

SeeAlso

publicstructCustomBlend

CopyC# JavaScript

Cinemachine

CustomBlendFields

TheCinemachineBlenderSettingsCustomBlendtypeexposesthefollowingmembers.

m_Blend

m_From

SeeAlsoReferenceCinemachineBlenderSettingsCustomBlendStructureCinemachineNamespace

Cinemachine

CinemachineBlenderSettingsCustomBlendField

[Missing<summary>documentationfor"F:Cinemachine.CinemachineBlenderSettings.CustomBlend.m_Blend"]

Syntax

FieldValueType:CinemachineBlendDefinition

[TooltipAttribute("Blendcurvedefinition")]

publicCinemachineBlendDefinitionm_Blend

CopyC# JavaScript

Cinemachine

[Missing<summary>documentationfor"F:Cinemachine.CinemachineBlenderSettings.CustomBlend.m_From"]

Syntax

[TooltipAttribute("Whenblendingfromthiscamera")]

publicstringm_From

CopyC# JavaScript

Cinemachine

[Missing<summary>documentationfor"F:Cinemachine.CinemachineBlenderSettings.CustomBlend.m_To"]

Syntax

[TooltipAttribute("Whenblendingtothiscamera")]

publicstringm_To

CopyC# JavaScript

Cinemachine

CinemachineBlendListCameraClass

Thisisavirtualcamera"manager"thatownsandmanagesacollectionofchildVirtualCameras.Whenthecameragoeslive,thesechildvcamsareenabled,oneafteranother,holdingeachcameraforadesignatedtime.Blendsbetweencamerasarespecified.Thelastcameraisheldindefinitely.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineVirtualCameraBaseCinemachineCinemachineBlendListCamera

Syntax

TheCinemachineBlendListCameratypeexposesthefollowingmembers.

[ExecuteInEditMode]

[DisallowMultipleComponent]

[AddComponentMenu("Cinemachine/CinemachineBlendListCamera")]

publicclassCinemachineBlendListCamera:CinemachineVirtualCameraBase

CopyC# JavaScript

CinemachineBlendListCamera

ChildCameras Thelistofchildcameras.Thesearejusttheimmediatechildreninthehierarchy.

Description Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo(OverridesCinemachineVirtualCameraBase

Follow GetthecurrentFollowtarget.Returnsparent'sFollowifparentisnon-nullandnospecificFollowdefinedforthiscamera(OverridesCinemachineVirtualCameraBase

IsBlending Isthereablendinprogress?

LiveChild Getthecurrent"best"childvirtualcamera,thatwouldbechoseniftheStateDrivenCamerawereactive.

LiveChildOrSelf Returnthelivechild.(OverridesCinemachineVirtualCameraBase

LookAt GetthecurrentLookAttarget.LookAtifparentisnon-nullandnospecific

LookAtdefinedforthiscamera(OverridesCinemachineVirtualCameraBase

Name GetthenameoftheVirtualCamera.implementationreturnstheownerGameObject'sname.(InheritedfromCinemachineVirtualCameraBase

ParentCamera Supportformeta-virtual-cameras.situationwhereavirtualcameraisinfactthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.ThismethodgetstheVirtualCameraowner,ifany.areimplementedasTransformchildrenoftheparentvcam.(InheritedfromCinemachineVirtualCameraBase

PreviousStateIsValid SetthistoforcethenextupdatetoignoredeltaTimeandresetitself(InheritedfromCinemachineVirtualCameraBase

Priority GetthePriorityofthevirtualcamera.determinesitsplacementintheCinemachineCore'squeueofeligibleshots.(InheritedfromCinemachineVirtualCameraBase

State TheStateofthecurrentlivechild(OverridesCinemachineVirtualCameraBase

ValidatingStreamVersion Versionthatwaslaststreamed,forupgradinglegacy(InheritedfromCinemachineVirtualCameraBase

VirtualCameraGameObject TheGameObjectowneroftheVirtualCamerabehaviour.(InheritedfromCinemachineVirtualCameraBase

AddPostPipelineStageHook Adelegatetohookintothestatecalculationpipeline.pipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase

InvokePostPipelineStageCallback InvokesthePostPipelineStageDelegateforthiscamera,andupthehierarchyforall(InheritedfromCinemachineVirtualCameraBase

IsLiveChild Checkwhetherthevcamalivechildofthiscamera.(OverridesCinemachineVirtualCameraBase

MoveToTopOfPrioritySubqueue Whenmultiplevirtualcamerashavethehighestpriority,thereisLivecameraifitsharesthehighestpriorityinthequeuewithitspeers.themostrecentonegoestothetopoftheprioritysubqueue.anditspeerssharethehighestpriority,thenthisvcamwillbecomeLive.(InheritedfromCinemachineVirtualCameraBase

OnDestroy Baseclassimplementationremovesthevirtualcamerafromthepriorityqueue.(InheritedfromCinemachineVirtualCameraBase

OnDisable Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(InheritedfromCinemachineVirtualCameraBase

OnEnable Makessuretheinternalchildcacheisuptodate(OverridesCinemachineVirtualCameraBase

OnTransformChildrenChanged Makessuretheinternalchildcacheisuptodate

OnTransformParentChanged Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(InheritedfromCinemachineVirtualCameraBase

OnTransitionFromCamera (OverridesCinemachineVirtualCameraBase

OnValidate Enforceboundsforfields,whenchangedininspector.basemethodiscalled,ValidatingStreamVersionwillbevalid.

(InheritedfromCinemachineVirtualCameraBase

PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,areupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledLateUpdateinstead.Baseclassimplementationdoesnothing.(InheritedfromCinemachineVirtualCameraBase

RemovePostPipelineStageHook RemoveaPipelinestagehookcallback.(OverridesCinemachineVirtualCameraBase

ResolveFollow Returnsthisvcam'sFollowtarget,orifthatisnull,willretrun(InheritedfromCinemachineVirtualCameraBase

ResolveLookAt Returnsthisvcam'sLookAttarget,orifthatisnull,willretrun(InheritedfromCinemachineVirtualCameraBase

Start Baseclassimplementationdoesnothing.(InheritedfromCinemachineVirtualCameraBase

Update Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(InheritedfromCinemachineVirtualCameraBase

UpdateCameraState CalledbyCinemachineCoreatdesignatedupdatetimeupdatesallthechildren,choosesthebestone,andimplementsanyrequiredblending.(OverridesCinemachineVirtualCameraBase

ValidateInstructions InternalAPIfortheinspectoreditor.

CinemachineGUIDebuggerCallback Thisisdeprecated.Itisheretosupportthesoon-to-be-removedCinemachineDebuggerintheEditor.

m_ChildCameras InternalAPIfortheeditor.usethisfield

m_EnableAllChildCameras Forceallchildcamerastobeenabled.ThisisusefulifanimatingtheminTimeline,butconsumesextraresources.

m_ExcludedPropertiesInInspector Inspectorcontrol-UseforhidingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase

m_Follow Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildrig.Maybeempty

m_Instructions Thesetofinstructionsassociatingvirtualcameraswithstates.setofinstructionsforenablingchildcameras

m_LockStageInInspector Inspectorcontrol-UseforenablingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase

m_LookAt Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildrig.Maybeempty

m_Priority Theprioritywilldeterminewhichcamerabecomesactivebasedon

thestateofothercamerasandthiscamera.Highernumbershavegreaterpriority.(InheritedfromCinemachineVirtualCameraBase

m_ShowDebugText Whenenabled,thecurrentcameraandblendwillbeindicatedinthegamewindow,fordebugging

OnPostPipelineStage Adelegatetohookintothestatecalculationpipeline.Implementaionmustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase

Cinemachine

CinemachineBlendListCameraConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineBlendListCamera.#ctor"]

Syntax

SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace

publicCinemachineBlendListCamera()

CopyC# JavaScript

Cinemachine

CinemachineBlendListCameraProperties

LookAt GetthecurrentLookAttarget.

LookAtifparentisnon-nullandnospecificLookAtdefinedforthiscamera(OverridesCinemachineVirtualCameraBase

Cinemachine

CinemachineBlendListCameraChildCamerasProperty

Thelistofchildcameras.Thesearejusttheimmediatechildreninthehierarchy.

Syntax

PropertyValueType:CinemachineVirtualCameraBase

publicCinemachineVirtualCameraBase[]ChildCameras{

CopyC# JavaScript

Cinemachine

CinemachineBlendListCameraDescriptionProperty

Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo

Syntax

PropertyValueType:StringImplementsICinemachineCameraDescription

publicoverridestringDescription{get;}

CopyC# JavaScript

Cinemachine

CinemachineBlendListCameraFollowProperty

GetthecurrentFollowtarget.Returnsparent'sFollowifparentisnon-nullandnospecificFollowdefinedforthiscamera

Syntax

PropertyValueType:TransformImplementsICinemachineCameraFollow

publicoverrideTransformFollow{get;set;}

CopyC# JavaScript

Cinemachine

CinemachineBlendListCameraIsBlendingProperty

Isthereablendinprogress?

Syntax

publicboolIsBlending{get;}

CopyC# JavaScript

Cinemachine

CinemachineBlendListCameraLiveChildProperty

Getthecurrent"best"childvirtualcamera,thatwouldbechoseniftheStateDrivenCamerawereactive.

Syntax

publicICinemachineCameraLiveChild{get;set;}

CopyC# JavaScript

Cinemachine

CinemachineBlendListCameraLiveChildOrSelfProperty

Returnthelivechild.

Syntax

PropertyValueType:ICinemachineCameraImplementsICinemachineCameraLiveChildOrSelf

publicoverrideICinemachineCameraLiveChildOrSelf{

CopyC# JavaScript

Cinemachine

CinemachineBlendListCameraLookAtProperty

GetthecurrentLookAttarget.Returnsparent'sLookAtifparentisnon-nullandnospecificLookAtdefinedforthiscamera

Syntax

PropertyValueType:TransformImplementsICinemachineCameraLookAt

publicoverrideTransformLookAt{get;set;}

CopyC# JavaScript

Cinemachine

CinemachineBlendListCameraStateProperty

TheStateofthecurrentlivechild

Syntax

PropertyValueType:CameraStateImplementsICinemachineCameraState

publicoverrideCameraStateState{get;}

CopyC# JavaScript

Cinemachine

CinemachineBlendListCameraMethods

OnTransitionFromCamera (OverridesCinemachineVirtualCameraBase

OnValidate Enforceboundsforfields,whenchangedininspector.basemethodiscalled,ValidatingStreamVersionwillbevalid.(InheritedfromCinemachineVirtualCameraBase

Cinemachine

CinemachineBlendListCameraIsLiveChildMethod

Checkwhetherthevcamalivechildofthiscamera.

Syntax

Parameters

vcamType:CinemachineICinemachineCameraTheVirtualCameratocheck

ReturnValueType:BooleanTrueifthevcamiscurrentlyactivelyinfluencingthestateofthisvcamImplementsICinemachineCameraIsLiveChild(ICinemachineCamera)

publicoverrideboolIsLiveChild(

ICinemachineCameravcam

CopyC# JavaScript

Cinemachine

CinemachineBlendListCameraOnEnableMethod

Makessuretheinternalchildcacheisuptodate

Syntax

protectedoverridevoidOnEnable()

CopyC# JavaScript

Cinemachine

CinemachineBlendListCameraOnTransformChildrenChangedMethod

Syntax

publicvoidOnTransformChildrenChanged()

CopyC# JavaScript

Cinemachine

CinemachineBlendListCameraOnTransitionFromCameraMethod

[Missing<summary>documentationfor"M:Cinemachine.CinemachineBlendListCamera.OnTransitionFromCamera(Cinemachine.ICinemachineCamera)"]

Syntax

Parameters

fromCamType:CinemachineICinemachineCamera[Missing<paramname="fromCam"/>documentationfor"M:Cinemachine.CinemachineBlendListCamera.OnTransitionFromCamera(Cinemachine.ICinemachineCamera)"]

ImplementsICinemachineCameraOnTransitionFromCamera(ICinemachineCamera)

publicoverridevoidOnTransitionFromCamera(

ICinemachineCamerafromCam

CopyC# JavaScript

Cinemachine

CinemachineBlendListCameraRemovePostPipelineStageHookMethod

RemoveaPipelinestagehookcallback.Makesureitisremovedfromallthechildren.

Syntax

Parameters

dType:CinemachineCinemachineVirtualCameraBaseOnPostPipelineStageDelegateThedelegatetoremove.

publicoverridevoidRemovePostPipelineStageHook(

CopyC# JavaScript

Cinemachine

CinemachineBlendListCameraUpdateCameraStateMethod

CalledbyCinemachineCoreatdesignatedupdatetimesothevcamcanpositionitselfandtrackitstargets.Thisimplementationupdatesallthechildren,choosesthebestone,andimplementsanyrequiredblending.

Syntax

Parameters

worldUpType:Vector3DefaultworldUp,setbytheCinemachineBrain

deltaTimeType:SystemSingleDeltatimefortime-basedeffects(ignoreiflessthanorequalto0)

ImplementsICinemachineCameraUpdateCameraState(Vector3,Single)

SeeAlso

publicoverridevoidUpdateCameraState(

Vector3worldUp,

floatdeltaTime

CopyC# JavaScript

ReferenceCinemachineBlendListCameraClassCinemachineNamespace

Cinemachine

CinemachineBlendListCameraValidateInstructionsMethod

InternalAPIfortheinspectoreditor.

Syntax

publicvoidValidateInstructions()

CopyC# JavaScript

Cinemachine

CinemachineBlendListCameraFields

CinemachineGUIDebuggerCallback Thisisdeprecated.Itisheretosupportthesoon-to-be-removedCinemachineDebuggerintheEditor.(InheritedfromCinemachineVirtualCameraBase

m_ChildCameras InternalAPIfortheeditor.usethisfield

m_Instructions Thesetofinstructionsassociatingvirtualcameraswithstates.setofinstructionsforenablingchildcameras

m_Priority Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthiscamera.Highernumbershavegreaterpriority.(InheritedfromCinemachineVirtualCameraBase

Cinemachine

CinemachineBlendListCameram_ChildCamerasField

InternalAPIfortheeditor.Donotusethisfield

Syntax

FieldValueType:CinemachineVirtualCameraBase

[SerializeField]

[HideInInspector]

publicCinemachineVirtualCameraBase[]m_ChildCameras

CopyC# JavaScript

Cinemachine

CinemachineBlendListCameram_EnableAllChildCamerasField

Forceallchildcamerastobeenabled.ThisisusefulifanimatingtheminTimeline,butconsumesextraresources.

Syntax

[TooltipAttribute("Forceallchildcamerastobeenabled.ThisisusefulifanimatingtheminTimeline,butconsumesextraresources")]

publicboolm_EnableAllChildCameras

CopyC# JavaScript

Cinemachine

CinemachineBlendListCameram_FollowField

Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildrig.Maybeempty

Syntax

FieldValueType:Transform

[TooltipAttribute("Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildcamera.Maybeemptyifallofthechildrendefinetargetsoftheirown.")]

publicTransformm_Follow

CopyC# JavaScript

Cinemachine

CinemachineBlendListCameram_InstructionsField

Thesetofinstructionsassociatingvirtualcameraswithstates.Thesetofinstructionsforenablingchildcameras

Syntax

FieldValueType:CinemachineBlendListCameraInstruction

[TooltipAttribute("Thesetofinstructionsforenablingchildcameras.")]

publicCinemachineBlendListCameraInstruction[]m_Instructions

CopyC# JavaScript

Cinemachine

CinemachineBlendListCameram_LookAtField

Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildrig.Maybeempty

Syntax

[TooltipAttribute("Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildcamera.Maybeemptyifallofthechildrendefinetargetsoftheirown.")]

publicTransformm_LookAt

CopyC# JavaScript

Cinemachine

CinemachineBlendListCameram_ShowDebugTextField

Whenenabled,thecurrentcameraandblendwillbeindicatedinthegamewindow,fordebugging

Syntax

[TooltipAttribute("Whenenabled,thecurrentchildcameraandblendwillbeindicatedinthegamewindow,fordebugging")]

publicboolm_ShowDebugText

CopyC# JavaScript

Cinemachine

CinemachineBlendListCameraInstructionStructure

ThisrepresentsasingleentryintheinstrunctionlistoftheBlendListCamera.

Syntax

TheCinemachineBlendListCameraInstructiontypeexposesthefollowingmembers.

m_Blend Howtoblendtothenextvirtualcamerainthelist(ifany)

m_Hold Howlongtowait(inseconds)beforeactivatingthenextvirtualcamerainthelist(ifany)

m_VirtualCamera Thevirtualcameratoactivatewhenthisinstructionbecomes

publicstructInstruction

CopyC# JavaScript

active

Cinemachine

InstructionFields

TheCinemachineBlendListCameraInstructiontypeexposesthefollowingmembers.

m_Blend Howtoblendtothenextvirtualcamerainthelist(ifany)

m_Hold Howlongtowait(inseconds)beforeactivatingthenextvirtualcamerainthelist(ifany)

m_VirtualCamera Thevirtualcameratoactivatewhenthisinstructionbecomesactive

SeeAlsoReferenceCinemachineBlendListCameraInstructionStructureCinemachineNamespace

Cinemachine

CinemachineBlendListCameraInstructionField

Howtoblendtothenextvirtualcamerainthelist(ifany)

Syntax

[CinemachineBlendDefinitionPropertyAttribute]

[TooltipAttribute("Howtoblendtothenextvirtualcamerainthelist(ifany)")]

publicCinemachineBlendDefinitionm_Blend

CopyC# JavaScript

Cinemachine

Howlongtowait(inseconds)beforeactivatingthenextvirtualcamerainthelist(ifany)

Syntax

[TooltipAttribute("Howlongtowait(inseconds)beforeactivatingthenextvirtualcamerainthelist(ifany)")]

publicfloatm_Hold

CopyC# JavaScript

Cinemachine

Thevirtualcameratoactivatewhenthisinstructionbecomesactive

Syntax

[TooltipAttribute("Thevirtualcameratoactivatewhenthisinstructionbecomesactive")]

publicCinemachineVirtualCameraBasem_VirtualCamera

CopyC# JavaScript

Cinemachine

CinemachineBrainClass

CinemachineBrainisthelinkbetweentheUnityCameraandtheCinemachineVirtualCamerasinthescene.ItmonitorstheprioritystacktochoosethecurrentVirtualCamera,andblendwithanotherifnecessary.Finallyandmostimportantly,itappliestheVirtualCamerastatetotheattachedUnityCamera.TheCinemachineBrainisalsotheplacewhererulesforblendingbetweenvirtualcamerasaredefined.Camerablendingisaninterpolationovertimeofonevirtualcamerapositionandstatetoanother.Ifyouthinkofvirtualcamerasascameramen,thenblendingisalittlelikeonecameramansmoothlypassingthecameratoanothercameraman.Youcanspecifythetimeoverwhichtoblend,aswellastheblendcurveshape.Notethatacameracutisjustazero-timeblend.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineBrain

Syntax

[ExecuteInEditMode]

[AddComponentMenu("Cinemachine/CinemachineBrain")]

publicclassCinemachineBrain:MonoBehaviour

CopyC# JavaScript

TheCinemachineBraintypeexposesthefollowingmembers.

CinemachineBrain

ActiveBlend Getthecurrentblendinprogress.Returnsnullifnone.

ActiveVirtualCamera Getthecurrentactivevirtualcamera.

CurrentCameraState Thecurrentstateappliedtotheunitycamera(maybetheresultofablend)

DefaultWorldUp Getthedefaultworldupforthevirtualcameras.

OutputCamera GettheUnityCamerathatisattachedtothisGameObject.Thisisthecamerathatwillbecontrolledbythebrain.

SoloCamera APIfortheUnityEditor.Showthiscameranomatterwhat.Thisisstatic,andsoaffectsallCinemachinebrains.

GetSoloGUIColor APIfortheUnityEditor.

IsLive TrueiftheICinemachineCamerathecurrentactivecamera,orpartofacurrentblend,eitherdirectlyorindirectlybecauseitsparentsarelive.

m_CameraActivatedEvent Thiseventwillfirewheneveravirtualcameragoeslive.Ifablendisinvolved,thentheeventwillfireonthefirstframeoftheblend

m_CameraCutEvent Thiseventwillfirewheneveravirtualcameragoesliveandthereisnoblend

m_CustomBlends Thisistheassetwhichcontainscustomsettingsforspecificblends.

m_DefaultBlend Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCameras.

m_IgnoreTimeScale Whenenabled,thecameraswillalwaysrespondinreal-timetouserinputanddamping,evenifthegameisrunninginslowmotion

m_ShowCameraFrustum Whenenabled,showsthecamera'sfrustuminthesceneview.

m_ShowDebugText Whenenabled,thecurrentcameraandblendwillbeindicatedinthegamewindow,fordebugging.

m_UpdateMethod Dependingonhowthetargetobjectsareanimated,adjusttheupdatemethodtominimizethepotentialjitter.UseFixedUpdateifallyourtargetsareanimatedwithfor

RigidBodyanimation.SmartUpdatewillchoosethebestmethodforeachvirtualcamera,dependingonhowthetargetisanimated.

m_WorldUpOverride Ifset,thisobject'sYaxiswilldefinetheworldspaceUpvectorforallthevirtualcameras.Thisisusefulintop-downgameenvironments.Ifnotset,UpisworldspaceY.

Cinemachine

CinemachineBrainConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineBrain.#ctor"]

Syntax

SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace

publicCinemachineBrain()

CopyC# JavaScript

Cinemachine

CinemachineBrainProperties

ActiveBlend Getthecurrentblendinprogress.Returnsnullifnone.

ActiveVirtualCamera Getthecurrentactivevirtualcamera.

CurrentCameraState Thecurrentstateappliedtotheunitycamera(maybetheresultofablend)

DefaultWorldUp Getthedefaultworldupforthevirtualcameras.

OutputCamera GettheUnityCamerathatisattachedtothisGameObject.Thisisthecamerathatwillbecontrolledbythebrain.

SoloCamera APIfortheUnityEditor.Showthiscameranomatterwhat.Thisisstatic,andsoaffectsallCinemachinebrains.

Cinemachine

CinemachineBrainActiveBlendProperty

Getthecurrentblendinprogress.Returnsnullifnone.

Syntax

PropertyValueType:CinemachineBlend

publicCinemachineBlendActiveBlend{get;}

CopyC# JavaScript

Cinemachine

CinemachineBrainActiveVirtualCameraProperty

Getthecurrentactivevirtualcamera.

Syntax

publicICinemachineCameraActiveVirtualCamera{get

CopyC# JavaScript

Cinemachine

CinemachineBrainCurrentCameraStateProperty

Thecurrentstateappliedtotheunitycamera(maybetheresultofablend)

Syntax

publicCameraStateCurrentCameraState{get;}

CopyC# JavaScript

Cinemachine

CinemachineBrainDefaultWorldUpProperty

Getthedefaultworldupforthevirtualcameras.

Syntax

publicVector3DefaultWorldUp{get;}

CopyC# JavaScript

Cinemachine

CinemachineBrainIsBlendingProperty

Syntax

CopyC# JavaScript

Cinemachine

CinemachineBrainOutputCameraProperty

GettheUnityCamerathatisattachedtothisGameObject.Thisisthecamerathatwillbecontrolledbythebrain.

Syntax

PropertyValueType:Camera

publicCameraOutputCamera{get;}

CopyC# JavaScript

Cinemachine

CinemachineBrainSoloCameraProperty

APIfortheUnityEditor.Showthiscameranomatterwhat.Thisisstatic,andsoaffectsallCinemachinebrains.

Syntax

publicstaticICinemachineCameraSoloCamera{get;

CopyC# JavaScript

Cinemachine

CinemachineBrainMethods

GetSoloGUIColor APIfortheUnityEditor.

IsLive TrueiftheICinemachineCamerathecurrentactivecamera,orpartofacurrentblend,eitherdirectlyorindirectlybecauseitsparentsarelive.

Cinemachine

CinemachineBrainGetSoloGUIColorMethod

APIfortheUnityEditor.

Syntax

ReturnValueType:ColorColorusedtoindicatethatacameraisinSolomode.

publicstaticColorGetSoloGUIColor()

CopyC# JavaScript

Cinemachine

CinemachineBrainIsLiveMethod

TrueiftheICinemachineCamerathecurrentactivecamera,orpartofacurrentblend,eitherdirectlyorindirectlybecauseitsparentsarelive.

Syntax

Parameters

vcamType:CinemachineICinemachineCameraThecameratotestwhetheritislive

ReturnValueType:BooleanTrueifthecameraislive(directlyorindirectly)orpartofablendinprogress.

publicboolIsLive(

CopyC# JavaScript

Cinemachine

CinemachineBrainFields

m_CameraActivatedEvent Thiseventwillfirewheneveravirtualcameragoeslive.Ifablendisinvolved,thentheeventwillfireonthefirstframeoftheblend

m_CameraCutEvent Thiseventwillfirewheneveravirtualcameragoesliveandthereisnoblend

m_CustomBlends Thisistheassetwhichcontainscustomsettingsforspecificblends.

m_DefaultBlend Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCameras.

m_IgnoreTimeScale Whenenabled,thecameraswillalwaysrespondinreal-timetouserinputand

damping,evenifthegameisrunninginslowmotion

m_ShowCameraFrustum Whenenabled,showsthecamera'sfrustuminthesceneview.

m_ShowDebugText Whenenabled,thecurrentcameraandblendwillbeindicatedinthegamewindow,fordebugging.

m_UpdateMethod Dependingonhowthetargetobjectsareanimated,adjusttheupdatemethodtominimizethepotentialjitter.UseFixedUpdateifallyourtargetsareanimatedwithforRigidBodyanimation.SmartUpdatewillchoosethebestmethodforeachvirtualcamera,dependingonhowthetargetisanimated.

m_WorldUpOverride Ifset,thisobject'sYaxiswilldefinetheworldspaceUpvectorforallthevirtualcameras.Thisisusefulintop-downgameenvironments.Ifnotset,Upis

worldspaceY.

Cinemachine

CinemachineBrainm_CameraActivatedEventField

Thiseventwillfirewheneveravirtualcameragoeslive.Ifablendisinvolved,thentheeventwillfireonthefirstframeoftheblend

Syntax

FieldValueType:CinemachineBrainVcamEvent

[TooltipAttribute("Thiseventwillfirewheneveravirtualcameragoeslive.Ifablendisinvolved,thentheeventwillfireonthefirstframeoftheblend.")]

publicCinemachineBrainVcamEventm_CameraActivatedEvent

CopyC# JavaScript

Cinemachine

CinemachineBrainm_CameraCutEventField

Thiseventwillfirewheneveravirtualcameragoesliveandthereisnoblend

Syntax

FieldValueType:CinemachineBrainBrainEvent

[TooltipAttribute("Thiseventwillfirewheneveravirtualcameragoesliveandthereisnoblend")]

publicCinemachineBrainBrainEventm_CameraCutEvent

CopyC# JavaScript

Cinemachine

CinemachineBrainm_CustomBlendsField

Thisistheassetwhichcontainscustomsettingsforspecificblends.

Syntax

FieldValueType:CinemachineBlenderSettings

[TooltipAttribute("Thisistheassetthatcontainscustomsettingsforblendsbetweenspecificvirtualcamerasinyourscene")]

publicCinemachineBlenderSettingsm_CustomBlends

CopyC# JavaScript

Cinemachine

CinemachineBrainm_DefaultBlendField

Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCameras.

Syntax

[TooltipAttribute("Theblendthatisusedincaseswhereyouhaven'texplicitlydefinedablendbetweentwoVirtualCameras")]

publicCinemachineBlendDefinitionm_DefaultBlend

CopyC# JavaScript

Cinemachine

CinemachineBrainm_IgnoreTimeScaleField

Whenenabled,thecameraswillalwaysrespondinreal-timetouserinputanddamping,evenifthegameisrunninginslowmotion

Syntax

[TooltipAttribute("Whenenabled,thecameraswillalwaysrespondinreal-timetouserinputanddamping,evenifthegameisrunninginslowmotion")]

publicboolm_IgnoreTimeScale

CopyC# JavaScript

Cinemachine

CinemachineBrainm_ShowCameraFrustumField

Whenenabled,showsthecamera'sfrustuminthesceneview.

Syntax

[TooltipAttribute("Whenenabled,thecamera'sfrustumwillbeshownatalltimesinthesceneview")]

publicboolm_ShowCameraFrustum

CopyC# JavaScript

Cinemachine

CinemachineBrainm_ShowDebugTextField

Whenenabled,thecurrentcameraandblendwillbeindicatedinthegamewindow,fordebugging.

Syntax

[TooltipAttribute("Whenenabled,thecurrentcameraandblendwillbeindicatedinthegamewindow,fordebugging")]

CopyC# JavaScript

Cinemachine

CinemachineBrainm_UpdateMethodField

Dependingonhowthetargetobjectsareanimated,adjusttheupdatemethodtominimizethepotentialjitter.UseFixedUpdateifallyourtargetsareanimatedwithforRigidBodyanimation.SmartUpdatewillchoosethebestmethodforeachvirtualcamera,dependingonhowthetargetisanimated.

Syntax

FieldValueType:CinemachineBrainUpdateMethod

[TooltipAttribute("UseFixedUpdateifallyourtargetsareanimatedduringFixedUpdate(e.g.RigidBodies),LateUpdateifallyourtargetsareanimatedduringthenormalUpdateloop,andSmartUpdateifyouwantCinemachinetodotheappropriatethingonaper-targetbasis.SmartUpdateistherecommendedsetting")]

publicCinemachineBrainUpdateMethodm_UpdateMethod

CopyC# JavaScript

Cinemachine

CinemachineBrainm_WorldUpOverrideField

Ifset,thisobject'sYaxiswilldefinetheworldspaceUpvectorforallthevirtualcameras.Thisisusefulintop-downgameenvironments.Ifnotset,UpisworldspaceY.

Syntax

[TooltipAttribute("Ifset,thisobject'sYaxiswilldefinetheworldspaceUpvectorforallthevirtualcameras.Thisisusefulforinstanceintop-downgameenvironments.Ifnotset,UpisworldspaceY.Settingthisappropriatelyisimportant,becauseVirtualCamerasdon'tlikelookingstraightuporstraightdown.")]

publicTransformm_WorldUpOverride

CopyC# JavaScript

Cinemachine

CinemachineBrainBrainEventClass

EventwithaCinemachineBrainparameter

InheritanceHierarchySystemObjectUnityEventBaseUnityEventCinemachineBrainCinemachineCinemachineBrainBrainEvent

Syntax

TheCinemachineBrainBrainEventtypeexposesthefollowingmembers.

CinemachineBrainBrainEvent

Methods

publicclassBrainEvent:UnityEvent<CinemachineBrain

CopyC# JavaScript

Name Description

AddListener(UnityActionUTP) (InheritedfromUnityEventCinemachineBrain

AddListener(Object,MethodInfo) (InheritedfromUnityEventBase.)

FindMethod_Impl (InheritedfromUnityEventCinemachineBrain

GetPersistentEventCount (InheritedfromUnityEventBase.)

GetPersistentMethodName (InheritedfromUnityEventBase.)

GetPersistentTarget (InheritedfromUnityEventBase.)

Invoke(Object) (InheritedfromUnityEventBase.)

Invoke(UTP) (InheritedfromUnityEventCinemachineBrain

RegisterPersistentListener (InheritedfromUnityEventBase.)

RemoveAllListeners (InheritedfromUnityEventBase.)

RemoveListener(UnityActionUTP) (InheritedfromUnityEventCinemachineBrain

RemoveListener(Object,MethodInfo)

(InheritedfromUnityEventBase.)

SetPersistentListenerState (InheritedfromUnityEventBase.)

ToString (InheritedfromUnityEventBase.)

ValidateRegistration(MethodInfo,Object,PersistentListenerMode)

ValidateRegistration(MethodInfo,Object,PersistentListenerMode,Type)

ExplicitInterfaceImplementations Name

UnityEngine#ISerializationCallbackReceiver#OnAfterDeserialize

UnityEngine#ISerializationCallbackReceiver#OnBeforeSerialize

Cinemachine

CinemachineBrainBrainEventConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineBrain.BrainEvent.#ctor"]

Syntax

SeeAlsoReferenceCinemachineBrainBrainEventClassCinemachineNamespace

publicBrainEvent()

CopyC# JavaScript

Cinemachine

BrainEventMethods

TheCinemachineBrainBrainEventtypeexposesthefollowingmembers.

AddListener(UnityActionUTP) (InheritedfromUnityEventCinemachineBrain

AddListener(Object,MethodInfo) (InheritedfromUnityEventBase.)

FindMethod_Impl (InheritedfromUnityEventCinemachineBrain

GetPersistentEventCount (InheritedfromUnityEventBase.)

GetPersistentMethodName (InheritedfromUnityEventBase.)

GetPersistentTarget (InheritedfromUnityEventBase.)

Invoke(Object) (InheritedfromUnityEventBase.)

Invoke(UTP) (InheritedfromUnityEventCinemachineBrain

RegisterPersistentListener (InheritedfromUnityEventBase.)

RemoveAllListeners (Inheritedfrom

UnityEventBase.)

RemoveListener(UnityActionUTP) (InheritedfromUnityEventCinemachineBrain

SetPersistentListenerState (InheritedfromUnityEventBase.)

ToString (InheritedfromUnityEventBase.)

SeeAlsoReferenceCinemachineBrainBrainEventClass

Cinemachine

CinemachineBrainUpdateMethodEnumeration

Thisenumdefinestheoptionsavailablefortheupdatemethod.

Syntax

Members

FixedUpdate 0 VirtualcamerasareupdatedinsyncwiththePhysicsmodule,inFixedUpdate

LateUpdate 1 VirtualcamerasareupdatedinMonoBehaviourLateUpdate.

SmartUpdate 2 Virtualcamerasareupdatedaccordingtohowthetargetis

publicenumUpdateMethod

CopyC# JavaScript

updated.

Cinemachine

CinemachineBrainVcamEventClass

EventwithaICinemachineCameraparameter

InheritanceHierarchySystemObjectUnityEventBaseUnityEventICinemachineCameraCinemachineCinemachineBrainVcamEvent

Syntax

TheCinemachineBrainVcamEventtypeexposesthefollowingmembers.

CinemachineBrainVcamEvent

Methods

publicclassVcamEvent:UnityEvent<ICinemachineCamera

CopyC# JavaScript

Name Description

AddListener(UnityActionUTP) (InheritedfromUnityEventICinemachineCamera

AddListener(Object,MethodInfo) (InheritedfromUnityEventBase

FindMethod_Impl (InheritedfromUnityEventICinemachineCamera

GetPersistentEventCount (InheritedfromUnityEventBase

GetPersistentMethodName (InheritedfromUnityEventBase

GetPersistentTarget (InheritedfromUnityEventBase

Invoke(Object) (InheritedfromUnityEventBase

Invoke(UTP) (InheritedfromUnityEventICinemachineCamera

RegisterPersistentListener (InheritedfromUnityEventBase

RemoveAllListeners (InheritedfromUnityEventBase

RemoveListener(UnityActionUTP) (InheritedfromUnityEventICinemachineCamera

(InheritedfromUnityEventBase

SetPersistentListenerState (InheritedfromUnityEventBase

ToString (InheritedfromUnityEventBase

ValidateRegistration(MethodInfo,Object,PersistentListenerMode,

Cinemachine

CinemachineBrainVcamEventConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineBrain.VcamEvent.#ctor"]

Syntax

SeeAlsoReferenceCinemachineBrainVcamEventClassCinemachineNamespace

publicVcamEvent()

CopyC# JavaScript

Cinemachine

VcamEventMethods

TheCinemachineBrainVcamEventtypeexposesthefollowingmembers.

AddListener(UnityActionUTP) (InheritedfromUnityEventICinemachineCamera

AddListener(Object,MethodInfo) (InheritedfromUnityEventBase

FindMethod_Impl (InheritedfromUnityEventICinemachineCamera

GetPersistentEventCount (InheritedfromUnityEventBase

GetPersistentMethodName (InheritedfromUnityEventBase

GetPersistentTarget (InheritedfromUnityEventBase

Invoke(Object) (InheritedfromUnityEventBase

Invoke(UTP) (InheritedfromUnityEventICinemachineCamera

RegisterPersistentListener (InheritedfromUnityEventBase

RemoveAllListeners (InheritedfromUnityEventBase

RemoveListener(UnityActionUTP) (InheritedfromUnityEventICinemachineCamera

SetPersistentListenerState (InheritedfromUnityEventBase

ToString (InheritedfromUnityEventBase

SeeAlsoReferenceCinemachineBrainVcamEventClassCinemachineNamespace

Cinemachine

CinemachineClearShotClass

CinemachineClearShotisa"managercamera"thatownsandmanagesasetofVirtualCameragameObjectchildren.WhenLive,theClearShotwillcheckthechildren,andchoosetheonewiththebestqualityshotandmakeitLive.Thiscanbeaverypowerfultool.IfthechildcamerashaveCinemachineColliderextensions,theywillanalyzethescenefortargetobstructions,optimaltargetdistance,andotheritems,andreporttheirassessmentofshotqualitybacktotheClearShotparent,whowillthenchoosethebestone.Youcanusethistosetupcomplexmulti-cameracoverageofascene,andbeassuredthataclearshotofthetargetwillalwaysbeavailable.Ifmultiplechildcamerashavethesameshotquality,theonewiththehighestprioritywillbechosen.YoucanalsodefinecustomblendsbetweentheClearShotchildren.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineVirtualCameraBaseCinemachineCinemachineClearShot

Syntax

[ExecuteInEditMode]

[AddComponentMenu("Cinemachine/CinemachineClearShot")]

CopyC# JavaScript

TheCinemachineClearShottypeexposesthefollowingmembers.

CinemachineClearShot

LiveChild Getthecurrent"best"childvirtualcamera,thatwouldbechoseniftheClearShotcamerawereactive.

LiveChildOrSelf Returnthelivechild.(Overrides

publicclassCinemachineClearShot:CinemachineVirtualCameraBase

CinemachineVirtualCameraBase

LookAt GetthecurrentLookAttarget.LookAtifparentisnon-nullandnospecificLookAtdefinedforthiscamera(OverridesCinemachineVirtualCameraBase

State TheCameraStateofthecurrentlylivechild(OverridesCinemachineVirtualCameraBase

OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.(OverridesCinemachineVirtualCameraBase

ResetRandomization IfRandomizeChoiceisenabled,callthistore-randomizethechildrennextframe.

m_ActivateAfter Waitthismanysecondsbeforeactivatinganewchildcamera

m_ChildCameras InternalAPIfortheeditor.usethisfiled.

m_CustomBlends Thisistheassetwhichcontainscustomsettingsforspecificblends

m_DefaultBlend Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCameras

m_Follow Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildcamera.Maybeempty.

m_LookAt Defaultobjectforthecamerachildrentolookat(theaim

target),ifnotspecifiedinachildcamera.Maybeempty.

m_MinDuration Anactivecameramustbeactiveforatleastthismanyseconds,unlessahigher-prioritycamerawantstoactivate

m_RandomizeChoice Ifchecked,camerachoicewillberandomizedifmultiplecamerasareequallydesirable.childlistorderwillbeused

Cinemachine

CinemachineClearShotConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineClearShot.#ctor"]

Syntax

SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace

publicCinemachineClearShot()

CopyC# JavaScript

Cinemachine

CinemachineClearShotProperties

LiveChild Getthecurrent"best"childvirtualcamera,thatwouldbechoseniftheClearShotcamerawereactive.

LookAt GetthecurrentLookAttarget.LookAtifparentisnon-nullandnospecific

LookAtdefinedforthiscamera(OverridesCinemachineVirtualCameraBase

State TheCameraStateofthecurrentlylivechild(OverridesCinemachineVirtualCameraBase

Cinemachine

CinemachineClearShotChildCamerasProperty

Syntax

CopyC# JavaScript

Cinemachine

CinemachineClearShotDescriptionProperty

Syntax

CopyC# JavaScript

Cinemachine

CinemachineClearShotFollowProperty

Syntax

CopyC# JavaScript

Cinemachine

CinemachineClearShotIsBlendingProperty

Syntax

CopyC# JavaScript

Cinemachine

CinemachineClearShotLiveChildProperty

Getthecurrent"best"childvirtualcamera,thatwouldbechoseniftheClearShotcamerawereactive.

Syntax

CopyC# JavaScript

Cinemachine

CinemachineClearShotLiveChildOrSelfProperty

Returnthelivechild.

Syntax

CopyC# JavaScript

Cinemachine

CinemachineClearShotLookAtProperty

Syntax

CopyC# JavaScript

Cinemachine

CinemachineClearShotStateProperty

TheCameraStateofthecurrentlylivechild

Syntax

CopyC# JavaScript

Cinemachine

CinemachineClearShotMethods

OnTransformParentChanged Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.

OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.(OverridesCinemachineVirtualCameraBase

ResetRandomization IfRandomizeChoiceisenabled,callthistore-randomizethechildrennextframe.

SeeAlso

ReferenceCinemachineClearShotClassCinemachineNamespace

Cinemachine

CinemachineClearShotIsLiveChildMethod

Syntax

Parameters

CopyC# JavaScript

Cinemachine

CinemachineClearShotOnEnableMethod

Syntax

CopyC# JavaScript

Cinemachine

CinemachineClearShotOnTransformChildrenChangedMethod

Syntax

CopyC# JavaScript

Cinemachine

CinemachineClearShotOnTransitionFromCameraMethod

Notificationthatthisvirtualcameraisgoinglive.Thisimplementationresetsthechildrandomization.

Syntax

Parameters

fromCamType:CinemachineICinemachineCameraThecamerabeingdeactivated.Maybenull.

CopyC# JavaScript

Cinemachine

CinemachineClearShotRemovePostPipelineStageHookMethod

Syntax

Parameters

CopyC# JavaScript

Cinemachine

CinemachineClearShotResetRandomizationMethod

IfRandomizeChoiceisenabled,callthistore-randomizethechildrennextframe.Thisisusefulifyouwanttofreshenuptheshot.

Syntax

publicvoidResetRandomization()

CopyC# JavaScript

Cinemachine

CinemachineClearShotUpdateCameraStateMethod

Syntax

Parameters

deltaTimeType:SystemSingleDeltatimefortime-basedeffects(ignoreiflessthan0)

SeeAlso

Vector3worldUp,

floatdeltaTime

CopyC# JavaScript

ReferenceCinemachineClearShotClassCinemachineNamespace

Cinemachine

CinemachineClearShotFields

m_ActivateAfter Waitthismanysecondsbeforeactivatinganewchildcamera

m_ChildCameras InternalAPIfortheeditor.usethisfiled.

m_CustomBlends Thisistheassetwhichcontainscustomsettingsforspecificblends

m_DefaultBlend Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCameras

m_Follow Defaultobjectforthecamerachildrenwantstomovewith(the

bodytarget),ifnotspecifiedinachildcamera.Maybeempty.

m_LookAt Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildcamera.Maybeempty.

m_MinDuration Anactivecameramustbeactiveforatleastthismanyseconds,unlessahigher-prioritycamerawantstoactivate

m_RandomizeChoice Ifchecked,camerachoicewillberandomizedifmultiplecamerasareequallydesirable.childlistorderwillbeused

OnPostPipelineStage Adelegatetohookintothestatecalculationpipeline.

Implementaionmustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase

Cinemachine

CinemachineClearShotm_ActivateAfterField

Waitthismanysecondsbeforeactivatinganewchildcamera

Syntax

[TooltipAttribute("Waitthismanysecondsbeforeactivatinganewchildcamera")]

publicfloatm_ActivateAfter

CopyC# JavaScript

Cinemachine

CinemachineClearShotm_ChildCamerasField

InternalAPIfortheeditor.Donotusethisfiled.

Syntax

[SerializeField]

[HideInInspector]

publicCinemachineVirtualCameraBase[]m_ChildCameras

CopyC# JavaScript

Cinemachine

CinemachineClearShotm_CustomBlendsField

Thisistheassetwhichcontainscustomsettingsforspecificblends

Syntax

[HideInInspector]

CopyC# JavaScript

Cinemachine

CinemachineClearShotm_DefaultBlendField

Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCameras

Syntax

[TooltipAttribute("Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCameras")]

CopyC# JavaScript

Cinemachine

CinemachineClearShotm_FollowField

Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildcamera.Maybeempty.

Syntax

[TooltipAttribute("Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildcamera.Maybeemptyifallchildrenspecifytargetsoftheirown.")]

CopyC# JavaScript

Cinemachine

CinemachineClearShotm_LookAtField

Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildcamera.Maybeempty.

Syntax

[TooltipAttribute("Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildcamera.Maybeemptyifallchildrenspecifytargetsoftheirown.")]

CopyC# JavaScript

Cinemachine

CinemachineClearShotm_MinDurationField

Anactivecameramustbeactiveforatleastthismanyseconds,unlessahigher-prioritycamerawantstoactivate

Syntax

[TooltipAttribute("Anactivecameramustbeactiveforatleastthismanyseconds,unlessahigher-prioritycamerawantstoactivate")]

publicfloatm_MinDuration

CopyC# JavaScript

Cinemachine

CinemachineClearShotm_RandomizeChoiceField

Ifchecked,camerachoicewillberandomizedifmultiplecamerasareequallydesirable.Otherwise,childlistorderwillbeused

Syntax

[TooltipAttribute("Ifchecked,camerachoicewillberandomizedifmultiplecamerasareequallydesirable.Otherwise,childlistorderandchildcameraprioritywillbeused.")]

publicboolm_RandomizeChoice

CopyC# JavaScript

Cinemachine

CinemachineClearShotm_ShowDebugTextField

Syntax

CopyC# JavaScript

Cinemachine

CinemachineColliderClass

Anadd-onmoduleforCinemachineVirtualCamerathatpost-processesthefinalpositionofthevirtualcamera.Basedonthesuppliedsettings,theColliderwillattempttopreservethelineofsightwiththeLookAttargetofthevirtualcamerabymovingawayfromobjectsthatwillobstructtheview.Additionally,theCollidercanbeusedtoassesstheshotqualityandreportthisasafieldinthecameraState.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineExtensionCinemachineCinemachineCollider

Syntax

TheCinemachineCollidertypeexposesthefollowingmembers.

Properties

[ExecuteInEditMode]

publicclassCinemachineCollider:CinemachineExtension

CopyC# JavaScript

Name Description

DebugPaths InspectorAPIfordebuggingcollisionresolutionpath

VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineExtension.)

Awake Connecttovirtualcamerapipeline.implementation(InheritedfromCinemachineExtension

CameraWasDisplaced Seewhetherthevirtualcamerahasbeenmovednbythecollider

GetAllExtraStatesT Ineffeicientmethodtogetallextrastateinforforallvcams.only,notruntime!(InheritedfromCinemachineExtension

GetExtraStateT Becauseextensionscanbeplacedonmanagercamsandwillinthatforallthevcamchildren,vcam-specificstateinformationdefineaclasstoholdyourstateinfo(InheritedfromCinemachineExtension

IsTargetObscured Seewheteranobjectisblockingthecamera'sviewofthetarget

OnDestroy Cleanup(OverridesCinemachineExtension

PostPipelineStageCallback Callcacktotothecollisionresolutionandshotevaluation(OverridesCinemachineExtensionPostPipelineStageCallback(CinemachineVirtualCameraBase,

CinemachineCoreStage,CameraState

m_AvoidObstacles Whenenabled,willattempttoresolvesituationswherethelineofsighttothetargetisblockedbyanobstacle

m_CameraRadius Camerawilltrytomaintainthisdistancefromanyobstacle.IncreasethisvalueifyouareseeinginsideobstaclesduetoalargeFOVonthecamera.

m_CollideAgainst TheUnitylayermaskagainstwhichthecolliderwillraycast.

m_Damping Thegradualnessofcollisionresolution.

Highernumberswillmovethecameramoregraduallyawayfromobstructions.

m_DistanceLimit Theraycastdistancetotestforwhencheckingifthelineofsighttothiscamera'stargetisclear.

m_MaximumEffort Upperlimitonhowmanyobstaclehitstoprocess.Highernumbersmayimpactperformance.Inmostenvironments,4isenough.

m_MinimumDistanceFromTarget Obstaclesclosertothetargetthanthiswillnotbeseen

m_OptimalTargetDistance Ifgreaterthanzero,ahigherscorewillbegiventoshotswhenthetargetisclosertothisdistance.Set

thistozerotodisablethisfeature

m_Strategy ThewayinwhichtheColliderwillattempttopreservesightofthetarget.

Cinemachine

CinemachineColliderProperties

DebugPaths InspectorAPIfordebuggingcollisionresolutionpath

SeeAlsoReferenceCinemachineColliderClassCinemachineNamespace

Cinemachine

CinemachineColliderDebugPathsProperty

InspectorAPIfordebuggingcollisionresolutionpath

Syntax

PropertyValueType:ListListVector3

publicList<List<Vector3>>DebugPaths{get;}

CopyC# JavaScript

Cinemachine

CinemachineColliderMethods

CameraWasDisplaced Seewhetherthevirtualcamerahasbeenmovednbythecollider

IsTargetObscured Seewheteranobjectisblockingthecamera'sviewofthetarget

OnDestroy Cleanup(OverridesCinemachineExtension

PostPipelineStageCallback Callcacktotothecollisionresolutionandshotevaluation(OverridesCinemachineExtensionPostPipelineStageCallback(CinemachineVirtualCameraBase,CinemachineCoreStage,CameraState

Cinemachine

CinemachineColliderCameraWasDisplacedMethod

Seewhetherthevirtualcamerahasbeenmovednbythecollider

Syntax

Parameters

vcamType:CinemachineCinemachineVirtualCameraBaseThevirtualcamerainquestion.Thismightbedifferentfromthevirtualcamerathatownsthecollider,intheeventthatthecamerahaschildren

ReturnValueType:BooleanTrueifthevirtualcamerahasbeendisplacedduetocollisionortargetobstruction

publicboolCameraWasDisplaced(

CinemachineVirtualCameraBasevcam

CopyC# JavaScript

Cinemachine

CinemachineColliderIsTargetObscuredMethod

Seewheteranobjectisblockingthecamera'sviewofthetarget

Syntax

Parameters

vcamType:CinemachineICinemachineCameraThevirtualcamerainquestion.Thismightbedifferentfromthevirtualcamerathatownsthecollider,intheeventthatthecamerahaschildren

ReturnValueType:BooleanTrueifsomethingisblockingtheview

publicboolIsTargetObscured(

CopyC# JavaScript

Cinemachine

CinemachineColliderOnDestroyMethod

Cleanup

Syntax

protectedoverridevoidOnDestroy()

CopyC# JavaScript

Cinemachine

CinemachineColliderPostPipelineStageCallbackMethod

Callcacktotothecollisionresolutionandshotevaluation

Syntax

Parameters

vcamType:CinemachineCinemachineVirtualCameraBase[Missing<paramname="vcam"/>documentationfor"M:Cinemachine.CinemachineCollider.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

stageType:CinemachineCinemachineCoreStage[Missing<paramname="stage"/>documentationfor"M:Cinemachine.CinemachineCollider.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

stateType:CinemachineCameraState[Missing<paramname="state"/>documentationfor"M:Cinemachine.CinemachineCollider.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

protectedoverridevoidPostPipelineStageCallback(

CinemachineVirtualCameraBasevcam,

CinemachineCoreStagestage,

refCameraStatestate,

floatdeltaTime

CopyC# JavaScript

deltaTimeType:SystemSingle[Missing<paramname="deltaTime"/>documentationfor"M:Cinemachine.CinemachineCollider.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

Cinemachine

CinemachineColliderFields

m_AvoidObstacles Whenenabled,willattempttoresolvesituationswherethelineofsighttothetargetisblockedbyanobstacle

m_CameraRadius Camerawilltrytomaintainthisdistancefromanyobstacle.IncreasethisvalueifyouareseeinginsideobstaclesduetoalargeFOVonthecamera.

m_CollideAgainst TheUnitylayermaskagainstwhichthecolliderwillraycast.

m_Damping The

gradualnessofcollisionresolution.Highernumberswillmovethecameramoregraduallyawayfromobstructions.

m_DistanceLimit Theraycastdistancetotestforwhencheckingifthelineofsighttothiscamera'stargetisclear.

m_MaximumEffort Upperlimitonhowmanyobstaclehitstoprocess.Highernumbersmayimpactperformance.Inmostenvironments,4isenough.

m_MinimumDistanceFromTarget Obstaclesclosertothetargetthanthiswillnotbeseen

m_OptimalTargetDistance Ifgreaterthanzero,ahigherscorewillbegiventoshots

whenthetargetisclosertothisdistance.Setthistozerotodisablethisfeature

m_Strategy ThewayinwhichtheColliderwillattempttopreservesightofthetarget.

Cinemachine

CinemachineColliderm_AvoidObstaclesField

Whenenabled,willattempttoresolvesituationswherethelineofsighttothetargetisblockedbyanobstacle

Syntax

[SpaceAttribute]

[TooltipAttribute("Whenenabled,willattempttoresolvesituationswherethelineofsighttothetargetisblockedbyanobstacle")]

[FormerlySerializedAsAttribute("m_PreserveLineOfSight")]

publicboolm_AvoidObstacles

CopyC# JavaScript

Cinemachine

CinemachineColliderm_CameraRadiusField

Camerawilltrytomaintainthisdistancefromanyobstacle.IncreasethisvalueifyouareseeinginsideobstaclesduetoalargeFOVonthecamera.

Syntax

[TooltipAttribute("Camerawilltrytomaintainthisdistancefromanyobstacle.Trytokeepthisvaluesmall.IncreaseitifyouareseeinginsideobstaclesduetoalargeFOVonthecamera.")]

publicfloatm_CameraRadius

CopyC# JavaScript

Cinemachine

CinemachineColliderm_CollideAgainstField

TheUnitylayermaskagainstwhichthecolliderwillraycast.

Syntax

FieldValueType:LayerMask

[HeaderAttribute("ObstacleDetection")]

[TooltipAttribute("TheUnitylayermaskagainstwhichthecolliderwillraycast")]

publicLayerMaskm_CollideAgainst

CopyC# JavaScript

Cinemachine

CinemachineColliderm_DampingField

Thegradualnessofcollisionresolution.Highernumberswillmovethecameramoregraduallyawayfromobstructions.

Syntax

[RangeAttribute(0f,10f)]

[TooltipAttribute("Thegradualnessofcollisionresolution.Highernumberswillmovethecameramoregraduallyawayfromobstructions.")]

[FormerlySerializedAsAttribute("m_Smoothing")]

publicfloatm_Damping

CopyC# JavaScript

Cinemachine

CinemachineColliderm_DistanceLimitField

Theraycastdistancetotestforwhencheckingifthelineofsighttothiscamera'stargetisclear.

Syntax

[TooltipAttribute("Themaximumraycastdistancewhencheckingifthelineofsighttothiscamera'stargetisclear.Ifthesettingis0orless,thecurrentactualdistancetotargetwillbeused.")]

[FormerlySerializedAsAttribute("m_LineOfSightFeelerDistance")]

publicfloatm_DistanceLimit

CopyC# JavaScript

Cinemachine

CinemachineColliderm_MaximumEffortField

Upperlimitonhowmanyobstaclehitstoprocess.Highernumbersmayimpactperformance.Inmostenvironments,4isenough.

Syntax

FieldValueType:Int32

[TooltipAttribute("Upperlimitonhowmanyobstaclehitstoprocess.Highernumbersmayimpactperformance.Inmostenvironments,4isenough.")]

publicintm_MaximumEffort

CopyC# JavaScript

Cinemachine

CinemachineColliderm_MinimumDistanceFromTargetField

Obstaclesclosertothetargetthanthiswillnotbeseen

Syntax

[TooltipAttribute("Obstaclesclosertothetargetthanthiswillnotbeseen")]

publicfloatm_MinimumDistanceFromTarget

CopyC# JavaScript

Cinemachine

CinemachineColliderm_OptimalTargetDistanceField

Ifgreaterthanzero,ahigherscorewillbegiventoshotswhenthetargetisclosertothisdistance.Setthistozerotodisablethisfeature

Syntax

[HeaderAttribute("ShotEvaluation")]

[TooltipAttribute("Ifgreaterthanzero,ahigherscorewillbegiventoshotswhenthetargetisclosertothisdistance.Setthistozerotodisablethisfeature.")]

publicfloatm_OptimalTargetDistance

CopyC# JavaScript

Cinemachine

CinemachineColliderm_StrategyField

ThewayinwhichtheColliderwillattempttopreservesightofthetarget.

Syntax

FieldValueType:CinemachineColliderResolutionStrategy

[TooltipAttribute("ThewayinwhichtheColliderwillattempttopreservesightofthetarget.")]

publicCinemachineColliderResolutionStrategym_Strategy

CopyC# JavaScript

Cinemachine

CinemachineColliderResolutionStrategyEnumeration

ThewayinwhichtheColliderwillattempttopreservesightofthetarget.

Syntax

Members Membername Value Description

PullCameraForward 0 CamerawillbepulledforwardalongitsZaxisuntilitisinfrontofthenearestobstacle

PreserveCameraHeight 1 Inadditiontopullingthecameraforward,aneffortwillbemadeto

publicenumResolutionStrategy

CopyC# JavaScript

returnthecameratoitsoriginalheight

PreserveCameraDistance 2 Inadditiontopullingthecameraforward,aneffortwillbemadetoreturnthecameratoitsoriginaldistancefromthetarget

Cinemachine

CinemachineComponentBaseClass

AnabstractrepresentationofamutatoractingonaCinemachineVirtualCamera

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseMore...

Syntax

TheCinemachineComponentBasetypeexposesthefollowingmembers.

CinemachineComponentBase

publicabstractclassCinemachineComponentBase:MonoBehaviour

CopyC# JavaScript

FollowTarget Returnstheownervcam'sFollowtarget.

IsValid Returnstrueifthisobjectisenabledandsetuptoproduceresults.

LookAtTarget Returnstheownervcam'sLookAttarget.

Stage Whatpartofthepipelinethisfitsinto

VcamState Returnstheownervcam'sCameraState.

VirtualCamera GettheassociatedCinemachineVirtualCameraBase

MutateCameraState Mutatesthecamerastate.Thisstatewilllaterbeappliedtothecamera.

OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.Baseclassimplementationdoes

nothing.

Epsilon Usefulconstantforverysmallfloats

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachineBasicMultiChannelPerlinCinemachineCinemachineComposerCinemachineCinemachineFramingTransposerCinemachineCinemachineHardLockToTargetCinemachineCinemachineHardLookAtCinemachineCinemachinePOVCinemachineCinemachineTrackedDollyCinemachineCinemachineTransposer

Cinemachine

CinemachineComponentBaseConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineComponentBase.#ctor"]

Syntax

SeeAlsoReferenceCinemachineComponentBaseClassCinemachineNamespace

protectedCinemachineComponentBase()

CopyC# JavaScript

Cinemachine

CinemachineComponentBaseProperties

FollowTarget Returnstheownervcam'sFollowtarget.

IsValid Returnstrueifthisobjectisenabledandsetuptoproduceresults.

LookAtTarget Returnstheownervcam'sLookAttarget.

Stage Whatpartofthepipelinethisfitsinto

VcamState Returnstheownervcam'sCameraState.

SeeAlsoReferenceCinemachineComponentBaseClass

Cinemachine

CinemachineComponentBaseFollowTargetProperty

Returnstheownervcam'sFollowtarget.

Syntax

PropertyValueType:Transform

publicTransformFollowTarget{get;}

CopyC# JavaScript

Cinemachine

CinemachineComponentBaseIsValidProperty

Returnstrueifthisobjectisenabledandsetuptoproduceresults.

Syntax

publicabstractboolIsValid{get;}

CopyC# JavaScript

Cinemachine

CinemachineComponentBaseLookAtTargetProperty

Returnstheownervcam'sLookAttarget.

Syntax

publicTransformLookAtTarget{get;}

CopyC# JavaScript

Cinemachine

CinemachineComponentBaseStageProperty

Whatpartofthepipelinethisfitsinto

Syntax

publicabstractCinemachineCoreStageStage{get;}

CopyC# JavaScript

Cinemachine

CinemachineComponentBaseVcamStateProperty

Returnstheownervcam'sCameraState.

Syntax

publicCameraStateVcamState{get;}

CopyC# JavaScript

Cinemachine

CinemachineComponentBaseVirtualCameraProperty

GettheassociatedCinemachineVirtualCameraBase

Syntax

publicCinemachineVirtualCameraBaseVirtualCamera{

CopyC# JavaScript

Cinemachine

CinemachineComponentBaseMethods

MutateCameraState Mutatesthecamerastate.Thisstatewilllaterbeappliedtothecamera.

OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.Baseclassimplementationdoesnothing.

Cinemachine

CinemachineComponentBaseMutateCameraStateMethod

Mutatesthecamerastate.Thisstatewilllaterbeappliedtothecamera.

Syntax

Parameters

curStateType:CinemachineCameraStateInputstatethatmustbemutated

publicabstractvoidMutateCameraState(

floatdeltaTime

CopyC# JavaScript

Cinemachine

CinemachineComponentBaseOnPositionDraggedMethod

APIfortheeditor,toprocessapositiondragfromtheuser.Baseclassimplementationdoesnothing.

Syntax

Parameters

deltaType:Vector3Theamountdraggedthisframe

publicvirtualvoidOnPositionDragged(

Vector3delta

CopyC# JavaScript

Cinemachine

CinemachineComponentBaseFields

Cinemachine

CinemachineComponentBaseEpsilonField

Usefulconstantforverysmallfloats

Syntax

protectedconstfloatEpsilon=0.0001f

CopyC# JavaScript

Cinemachine

CinemachineComposerClass

ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.Itsjobistoaimthecameraatthevcam'sLookAttargetobject,withconfigurableoffsets,damping,andcompositionrules.Thecomposerdoesnotchangethecamera'sposition.Itwillonlypanandtiltthecamerawhereitis,inordertogetthedesiredframing.Tomovethecamera,youhavetousethevirtualcamera'sBodysection.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachineComposerCinemachineCinemachineGroupComposer

Syntax

TheCinemachineComposertypeexposesthefollowingmembers.

[ExecuteInEditMode]

publicclassCinemachineComposer:CinemachineComponentBase

CopyC# JavaScript

HardGuideRect InternalAPIfortheinspectoreditor

IsValid TrueifcomponentisenabledandhasaLookAtdefined(OverridesCinemachineComponentBaseIsValid.)

SoftGuideRect InternalAPIfortheinspectoreditor

Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheAimstage(OverridesCinemachineComponentBaseStage.)

GetTrackedPoint Applythetargetoffsetstothetargetlocation.

MutateCameraState Appliesthecomposerrulesandorientsthecameraaccordingly(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)

m_BiasX Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone

m_BiasY Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone

m_DeadZoneHeight Camerawillnotrotateverticallyifthetargetiswithinthisrangeoftheposition

m_DeadZoneWidth Camerawillnotrotate

horizontallyifthetargetiswithinthisrangeoftheposition

m_HorizontalDamping Howaggressivelythecameratriestofollowthetargetinthescreen-horizontaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.

m_LookaheadSmoothing Controlsthesmoothnessofthelookaheadalgorithm.Largervaluessmoothoutjitterypredictionsandalsoincreasepredictionlag

m_LookaheadTime Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothe

future.Notethatthissettingissensitivetonoisyanimation,andcanamplifythenoise,resultinginundesirablecamerajitter.Ifthecamerajittersunacceptablywhenthetargetisinmotion,turndownthissetting,oranimatethetargetmoresmoothly.

m_ScreenX Horizontalscreenpositionfortarget.Thecamerawillrotatetothepositionthetrackedobjecthere

m_ScreenY Verticalscreenpositionfortarget,Thecamerawillrotatetotopositionthetrackedobjecthere

m_SoftZoneHeight Whentargetiswithinthisregion,camerawillgraduallymovetore-aligntowardsthedesiredposition,dependingonmthedampingspeed

m_SoftZoneWidth Whentargetiswithinthisregion,camerawillgraduallymovetore-aligntowardsthedesiredposition,dependingonmthedampingspeed

m_TrackedObjectOffset Targetoffsetfromtheobject'scenterinLOCALspacewhichtheComposertracks.Usethistofine-tunethetrackingtargetpositionwhenthedesiredareaisnotinthetrackedobject'scenter

m_VerticalDamping Howaggressivelythecameratriestofollowthetargetinthescreen-verticaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.

OnGUICallback UsedbytheInspectorEditortodisplayon-screenguides.

SeeAlsoReference

Cinemachine

CinemachineComposerProperties

VcamState Returnstheownervcam's

CameraState.(InheritedfromCinemachineComponentBase.)

SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace

Cinemachine

CinemachineComposerHardGuideRectProperty

InternalAPIfortheinspectoreditor

Syntax

PropertyValueType:Rect

publicRectHardGuideRect{get;set;}

CopyC# JavaScript

Cinemachine

CinemachineComposerIsValidProperty

TrueifcomponentisenabledandhasaLookAtdefined

Syntax

CopyC# JavaScript

Cinemachine

CinemachineComposerSoftGuideRectProperty

Syntax

publicRectSoftGuideRect{get;set;}

CopyC# JavaScript

Cinemachine

CinemachineComposerStageProperty

GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheAimstage

Syntax

CopyC# JavaScript

Cinemachine

CinemachineComposerMethods

GetTrackedPoint Applythetargetoffsetstothetargetlocation.

Cinemachine

CinemachineComposerGetTrackedPointMethod

Applythetargetoffsetstothetargetlocation.

Syntax

Parameters

lookAtType:Vector3TheunoffsetLookAtpoint

ReturnValueType:Vector3TheLookAtpointwiththeoffsetapplied

protectedvirtualVector3GetTrackedPoint(

Vector3lookAt

CopyC# JavaScript

Cinemachine

CinemachineComposerMutateCameraStateMethod

Appliesthecomposerrulesandorientsthecameraaccordingly

Syntax

Parameters

deltaTimeType:SystemSingleUsedforcalculatingdamping.Iflessthanzero,thentargetwillsnaptothecenterofthedeadzone.

floatdeltaTime

CopyC# JavaScript

Cinemachine

CinemachineComposerFields

m_DeadZoneHeight Camerawillnotrotateverticallyifthetargetiswithinthisrangeoftheposition

m_DeadZoneWidth Camerawillnotrotatehorizontallyifthetargetiswithinthisrangeoftheposition

m_HorizontalDamping Howaggressivelythecameratriestofollowthetargetinthescreen-horizontaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecamerato

keepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.

m_LookaheadTime Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothefuture.Notethatthissettingissensitivetonoisyanimation,andcanamplifythenoise,resultinginundesirablecamerajitter.Ifthecamerajittersunacceptablywhenthetargetisinmotion,turndownthissetting,oranimatethetargetmoresmoothly.

m_ScreenX Horizontalscreenpositionfortarget.Thecamerawillrotatetothepositionthetrackedobjecthere

m_ScreenY Verticalscreenpositionfortarget,Thecamerawillrotatetotopositionthetrackedobjecthere

m_TrackedObjectOffset Targetoffsetfromtheobject'scenterinLOCALspacewhichtheComposertracks.Usethistofine-tunethetrackingtargetpositionwhenthedesiredareaisnotinthetrackedobject'scenter

m_VerticalDamping Howaggressivelythecameratriestofollowthetargetinthescreen-verticaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.

Cinemachine

CinemachineComposerm_BiasXField

Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone

Syntax

[RangeAttribute(-0.5f,0.5f)]

[TooltipAttribute("Anon-zerobiaswillmovethetargetpositionhorizontallyawayfromthecenterofthesoftzone.")]

publicfloatm_BiasX

CopyC# JavaScript

Cinemachine

CinemachineComposerm_BiasYField

Syntax

[TooltipAttribute("Anon-zerobiaswillmovethetargetpositionverticallyawayfromthecenterofthesoftzone.")]

publicfloatm_BiasY

CopyC# JavaScript

Cinemachine

CinemachineComposerm_DeadZoneHeightField

Camerawillnotrotateverticallyifthetargetiswithinthisrangeoftheposition

Syntax

[TooltipAttribute("Camerawillnotrotateverticallyifthetargetiswithinthisrangeoftheposition.")]

publicfloatm_DeadZoneHeight

CopyC# JavaScript

Cinemachine

CinemachineComposerm_DeadZoneWidthField

Camerawillnotrotatehorizontallyifthetargetiswithinthisrangeoftheposition

Syntax

[TooltipAttribute("Camerawillnotrotatehorizontallyifthetargetiswithinthisrangeoftheposition.")]

publicfloatm_DeadZoneWidth

CopyC# JavaScript

Cinemachine

CinemachineComposerm_HorizontalDampingField

Howaggressivelythecameratriestofollowthetargetinthescreen-horizontaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.

Syntax

[SpaceAttribute]

[TooltipAttribute("Howaggressivelythecameratriestofollowthetargetinthescreen-horizontaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.")]

publicfloatm_HorizontalDamping

CopyC# JavaScript

Cinemachine

CinemachineComposerm_LookaheadSmoothingField

Controlsthesmoothnessofthelookaheadalgorithm.Largervaluessmoothoutjitterypredictionsandalsoincreasepredictionlag

Syntax

[TooltipAttribute("Controlsthesmoothnessofthelookaheadalgorithm.Largervaluessmoothoutjitterypredictionsandalsoincreasepredictionlag")]

publicfloatm_LookaheadSmoothing

CopyC# JavaScript

Cinemachine

CinemachineComposerm_LookaheadTimeField

Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothefuture.Notethatthissettingissensitivetonoisyanimation,andcanamplifythenoise,resultinginundesirablecamerajitter.Ifthecamerajittersunacceptablywhenthetargetisinmotion,turndownthissetting,oranimatethetargetmoresmoothly.

Syntax

[TooltipAttribute("Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothefuture.Notethatthissettingissensitivetonoisyanimation,andcanamplifythenoise,resultinginundesirablecamerajitter.Ifthecamerajittersunacceptablywhenthetargetisinmotion,turndownthissetting,oranimatethetargetmoresmoothly.")]

publicfloatm_LookaheadTime

CopyC# JavaScript

Cinemachine

CinemachineComposerm_ScreenXField

Horizontalscreenpositionfortarget.Thecamerawillrotatetothepositionthetrackedobjecthere

Syntax

[SpaceAttribute]

[TooltipAttribute("Horizontalscreenpositionfortarget.Thecamerawillrotatetopositionthetrackedobjecthere.")]

publicfloatm_ScreenX

CopyC# JavaScript

Cinemachine

CinemachineComposerm_ScreenYField

Verticalscreenpositionfortarget,Thecamerawillrotatetotopositionthetrackedobjecthere

Syntax

[TooltipAttribute("Verticalscreenpositionfortarget,Thecamerawillrotatetopositionthetrackedobjecthere.")]

publicfloatm_ScreenY

CopyC# JavaScript

Cinemachine

CinemachineComposerm_SoftZoneHeightField

Whentargetiswithinthisregion,camerawillgraduallymovetore-aligntowardsthedesiredposition,dependingonmthedampingspeed

Syntax

[TooltipAttribute("Whentargetiswithinthisregion,camerawillgraduallyrotateverticallytore-aligntowardsthedesiredposition,dependingonthedampingspeed.")]

publicfloatm_SoftZoneHeight

CopyC# JavaScript

Cinemachine

CinemachineComposerm_SoftZoneWidthField

Syntax

[TooltipAttribute("Whentargetiswithinthisregion,camerawillgraduallyrotatehorizontallytore-aligntowardsthedesiredposition,dependingonthedampingspeed.")]

publicfloatm_SoftZoneWidth

CopyC# JavaScript

Cinemachine

CinemachineComposerm_TrackedObjectOffsetField

Targetoffsetfromtheobject'scenterinLOCALspacewhichtheComposertracks.Usethistofine-tunethetrackingtargetpositionwhenthedesiredareaisnotinthetrackedobject'scenter

Syntax

[TooltipAttribute("Targetoffsetfromthetargetobject'scenterintarget-localspace.Usethistofine-tunethetrackingtargetpositionwhenthedesiredareaisnotthetrackedobject'scenter.")]

publicVector3m_TrackedObjectOffset

CopyC# JavaScript

Cinemachine

CinemachineComposerm_VerticalDampingField

Howaggressivelythecameratriestofollowthetargetinthescreen-verticaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.

Syntax

[TooltipAttribute("Howaggressivelythecameratriestofollowthetargetinthescreen-verticaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.")]

publicfloatm_VerticalDamping

CopyC# JavaScript

Cinemachine

CinemachineComposerOnGUICallbackField

UsedbytheInspectorEditortodisplayon-screenguides.

Syntax

FieldValueType:Action

[HideInInspector]

publicActionOnGUICallback

CopyC# JavaScript

Cinemachine

CinemachineConfinerClass

Anadd-onmoduleforCinemachineVirtualCamerathatpost-processesthefinalpositionofthevirtualcamera.Itwillconfinethevirtualcamera'spositiontothevolumespecifiedintheBoundingVolumefield.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineExtensionCinemachineCinemachineConfiner

Syntax

TheCinemachineConfinertypeexposesthefollowingmembers.

[ExecuteInEditMode]

publicclassCinemachineConfiner:CinemachineExtension

CopyC# JavaScript

CinemachineConfiner

IsValid Checkiftheboundingvolumeisdefined

CameraWasDisplaced Seewhetherthevirtualcamerahasbeenmovedbytheconfiner

InvalidatePathCache Callthisiftheboundingshape'spointschangeatruntime

OnDestroy Disconnectfromvirtualcamerapipeline.baseimplementation(InheritedfromCinemachineExtension

PostPipelineStageCallback Callbacktotothecameraconfining(OverridesCinemachineExtensionPostPipelineStageCallback(CinemachineVirtualCameraBase,CinemachineCoreStage,CameraState

m_BoundingShape2D The2Dshapewithinwhichthecameraistobecontained.

m_BoundingVolume Thevolumewithinwhichthecameraistobecontained.

m_ConfineMode Theconfinercanoperateusinga2Dboundingshapeora3Dboundingvolume

m_ConfineScreenEdges Ifcameraisorthographic,screenedgeswillbeconfinedtothevolume.

m_Damping Howgraduallytoreturnthecameratotheboundingvolumeifitgoesbeyondtheborders

Cinemachine

CinemachineConfinerConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineConfiner.#ctor"]

Syntax

SeeAlsoReferenceCinemachineConfinerClassCinemachineNamespace

publicCinemachineConfiner()

CopyC# JavaScript

Cinemachine

CinemachineConfinerProperties

IsValid Checkiftheboundingvolumeisdefined

Cinemachine

CinemachineConfinerIsValidProperty

Checkiftheboundingvolumeisdefined

Syntax

publicboolIsValid{get;}

CopyC# JavaScript

Cinemachine

CinemachineConfinerMethods

CameraWasDisplaced Seewhetherthevirtualcamerahasbeenmovedbytheconfiner

InvalidatePathCache Callthisiftheboundingshape'spointschangeatruntime

PostPipelineStageCallback Callbacktotothecameraconfining(OverridesCinemachineExtensionPostPipelineStageCallback(CinemachineVirtualCameraBase,CinemachineCoreStage,CameraState

Cinemachine

CinemachineConfinerCameraWasDisplacedMethod

Seewhetherthevirtualcamerahasbeenmovedbytheconfiner

Syntax

Parameters

vcamType:CinemachineCinemachineVirtualCameraBaseThevirtualcamerainquestion.Thismightbedifferentfromthevirtualcamerathatownstheconfiner,intheeventthatthecamerahaschildren

ReturnValueType:BooleanTrueifthevirtualcamerahasbeenrepositioned

publicboolCameraWasDisplaced(

CopyC# JavaScript

Cinemachine

CinemachineConfinerInvalidatePathCacheMethod

Callthisiftheboundingshape'spointschangeatruntime

Syntax

publicvoidInvalidatePathCache()

CopyC# JavaScript

Cinemachine

CinemachineConfinerPostPipelineStageCallbackMethod

Callbacktotothecameraconfining

Syntax

Parameters

vcamType:CinemachineCinemachineVirtualCameraBase[Missing<paramname="vcam"/>documentationfor"M:Cinemachine.CinemachineConfiner.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

stageType:CinemachineCinemachineCoreStage[Missing<paramname="stage"/>documentationfor"M:Cinemachine.CinemachineConfiner.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

stateType:CinemachineCameraState[Missing<paramname="state"/>documentationfor"M:Cinemachine.CinemachineConfiner.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

floatdeltaTime

CopyC# JavaScript

deltaTimeType:SystemSingle[Missing<paramname="deltaTime"/>documentationfor"M:Cinemachine.CinemachineConfiner.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

Cinemachine

CinemachineConfinerFields

m_BoundingShape2D The2Dshapewithinwhichthecameraistobecontained.

m_BoundingVolume Thevolumewithinwhichthecameraistobecontained.

m_ConfineMode Theconfinercanoperateusinga2Dboundingshapeora3Dboundingvolume

m_ConfineScreenEdges Ifcameraisorthographic,screenedgeswillbeconfinedtothevolume.

m_Damping Howgraduallytoreturnthecameratotheboundingvolumeifitgoesbeyondtheborders

SeeAlso

ReferenceCinemachineConfinerClassCinemachineNamespace

Cinemachine

CinemachineConfinerm_BoundingShape2DField

The2Dshapewithinwhichthecameraistobecontained.

Syntax

FieldValueType:Collider2D

[TooltipAttribute("The2Dshapewithinwhichthecameraistobecontained")]

publicCollider2Dm_BoundingShape2D

CopyC# JavaScript

Cinemachine

CinemachineConfinerm_BoundingVolumeField

Thevolumewithinwhichthecameraistobecontained.

Syntax

FieldValueType:Collider

[TooltipAttribute("Thevolumewithinwhichthecameraistobecontained")]

publicColliderm_BoundingVolume

CopyC# JavaScript

Cinemachine

CinemachineConfinerm_ConfineModeField

Theconfinercanoperateusinga2Dboundingshapeora3Dboundingvolume

Syntax

FieldValueType:CinemachineConfinerMode

[TooltipAttribute("Theconfinercanoperateusinga2Dboundingshapeora3Dboundingvolume")]

publicCinemachineConfinerModem_ConfineMode

CopyC# JavaScript

Cinemachine

CinemachineConfinerm_ConfineScreenEdgesField

Ifcameraisorthographic,screenedgeswillbeconfinedtothevolume.

Syntax

[TooltipAttribute("Ifcameraisorthographic,screenedgeswillbeconfinedtothevolume.Ifnotchecked,thenonlythecameracenterwillbeconfined")]

publicboolm_ConfineScreenEdges

CopyC# JavaScript

Cinemachine

CinemachineConfinerm_DampingField

Howgraduallytoreturnthecameratotheboundingvolumeifitgoesbeyondtheborders

Syntax

[TooltipAttribute("Howgraduallytoreturnthecameratotheboundingvolumeifitgoesbeyondtheborders.Highernumbersaremoregradual.")]

CopyC# JavaScript

Cinemachine

CinemachineConfinerModeEnumeration

Theconfinercanoperateusinga2Dboundingshapeora3Dboundingvolume

Syntax

Confine2D 0

Confine3D 1

publicenumMode

CopyC# JavaScript

Cinemachine

CinemachineCoreClass

AsingletonthatmanagescompletelistsofCinemachineBrainand,CinemachineVirtualCameras,andthepriorityqueue.ProvidesservicestokeepingtrackofwhetherCinemachineVirtualCamerashavebeenupdatedeachframe.

InheritanceHierarchySystemObjectCinemachineCinemachineCore

Syntax

TheCinemachineCoretypeexposesthefollowingmembers.

CinemachineCore

BrainCount Accessthearrayofactive

publicsealedclassCinemachineCore

CopyC# JavaScript

CinemachineBrainsinthescene

Instance Getthesingletoninstance

VirtualCameraCount ListofallactiveCinemachineVirtualCamerasforallbrains.Thislistiskeptsortedbypriority.

FindPotentialTargetBrain TrytofindaCinemachineBraintoassociatewithaCinemachineVirtualCamera.ThefirstCinemachineBraininwhichthisCinemachineVirtualCameraislivewillbeused.Ifnone,thenthefirstactiveCinemachineBrainwillbeused.BrainswithOutputCamera==nullwillnotbereturned.Finalresultmaybenull.

GenerateCameraActivationEvent Signalthatthevirtualhasbeenactivated.Ifthecameraislive,thenallCinemachineBrains

thatareshowingitwillsendanactivationevent.

GenerateCameraCutEvent Signalthatthevirtualcamera'scontentisdiscontinuousWRTthepreviousframe.Ifthecameraislive,thenallCinemachineBrainsthatareshowingitwillsendacutevent.

GetActiveBrain AccessthearrayofactiveCinemachineBrainsinthescenewithoutgebneratinggarbage

GetVcamUpdateStatus Internaluseonly

GetVirtualCamera AccessthearrayofactiveICinemachineCamerainthescenewithoutgebneratinggarbage

IsLive IsthisvirtualcameracurrentlyactivelycontrollinganyCamera?

GetInputAxis DelegateforoverridingUnity'sdefaultinputsystem.Ifyousetthis,thenyourdelegatewillbecalledinsteadofSystem.Input.GetAxis(axisName)wheneverin-gameuserinputisneeded.

kStreamingVersion Dataversionstring.Usedtoupgradefromlegacyprojects

kVersionString Human-readableCinemachineVersion

sShowHiddenObjects Iftrue,showhiddenCinemachineobjects,tomakemanualscriptmappingpossible.

Cinemachine

CinemachineCoreConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineCore.#ctor"]

Syntax

SeeAlsoReferenceCinemachineCoreClassCinemachineNamespace

publicCinemachineCore()

CopyC# JavaScript

Cinemachine

CinemachineCoreProperties

BrainCount AccessthearrayofactiveCinemachineBrainsinthescene

Instance Getthesingletoninstance

VirtualCameraCount ListofallactiveCinemachineVirtualCamerasforallbrains.Thislistiskeptsortedbypriority.

Cinemachine

CinemachineCoreBrainCountProperty

AccessthearrayofactiveCinemachineBrainsinthescene

Syntax

publicintBrainCount{get;}

CopyC# JavaScript

Cinemachine

CinemachineCoreInstanceProperty

Getthesingletoninstance

Syntax

PropertyValueType:CinemachineCore

publicstaticCinemachineCoreInstance{get;}

CopyC# JavaScript

Cinemachine

CinemachineCoreVirtualCameraCountProperty

ListofallactiveCinemachineVirtualCamerasforallbrains.Thislistiskeptsortedbypriority.

Syntax

publicintVirtualCameraCount{get;}

CopyC# JavaScript

Cinemachine

CinemachineCoreMethods

FindPotentialTargetBrain TrytofindaCinemachineBraintoassociatewithaCinemachineVirtualCamera.ThefirstCinemachineBraininwhichthisCinemachineVirtualCameraislivewillbeused.Ifnone,thenthefirstactiveCinemachineBrainwillbeused.BrainswithOutputCamera==nullwillnotbereturned.Finalresultmaybenull.

GenerateCameraActivationEvent Signalthatthevirtualhasbeenactivated.Ifthecameraislive,thenallCinemachineBrainsthatareshowingitwillsendanactivationevent.

GenerateCameraCutEvent Signalthatthevirtual

camera'scontentisdiscontinuousWRTthepreviousframe.Ifthecameraislive,thenallCinemachineBrainsthatareshowingitwillsendacutevent.

GetActiveBrain AccessthearrayofactiveCinemachineBrainsinthescenewithoutgebneratinggarbage

GetVcamUpdateStatus Internaluseonly

GetVirtualCamera AccessthearrayofactiveICinemachineCamerainthescenewithoutgebneratinggarbage

IsLive IsthisvirtualcameracurrentlyactivelycontrollinganyCamera?

Cinemachine

CinemachineCoreFindPotentialTargetBrainMethod

TrytofindaCinemachineBraintoassociatewithaCinemachineVirtualCamera.ThefirstCinemachineBraininwhichthisCinemachineVirtualCameraislivewillbeused.Ifnone,thenthefirstactiveCinemachineBrainwillbeused.BrainswithOutputCamera==nullwillnotbereturned.Finalresultmaybenull.

Syntax

Parameters

vcamType:CinemachineICinemachineCameraVirtualcamerawhosepotentialbrainweneed.

ReturnValueType:CinemachineBrainFirstCinemachineBrainfoundthatmightbeappropriateforthisvcam,ornull

SeeAlso

publicCinemachineBrainFindPotentialTargetBrain(

CopyC# JavaScript

ReferenceCinemachineCoreClassCinemachineNamespace

Cinemachine

CinemachineCoreGenerateCameraActivationEventMethod

Signalthatthevirtualhasbeenactivated.Ifthecameraislive,thenallCinemachineBrainsthatareshowingitwillsendanactivationevent.

Syntax

Parameters

vcamType:CinemachineICinemachineCamera[Missing<paramname="vcam"/>documentationfor"M:Cinemachine.CinemachineCore.GenerateCameraActivationEvent(Cinemachine.ICinemachineCamera)"]

publicvoidGenerateCameraActivationEvent(

CopyC# JavaScript

Cinemachine

CinemachineCoreGenerateCameraCutEventMethod

Signalthatthevirtualcamera'scontentisdiscontinuousWRTthepreviousframe.Ifthecameraislive,thenallCinemachineBrainsthatareshowingitwillsendacutevent.

Syntax

Parameters

vcamType:CinemachineICinemachineCamera[Missing<paramname="vcam"/>documentationfor"M:Cinemachine.CinemachineCore.GenerateCameraCutEvent(Cinemachine.ICinemachineCamera)"]

publicvoidGenerateCameraCutEvent(

CopyC# JavaScript

Cinemachine

CinemachineCoreGetActiveBrainMethod

AccessthearrayofactiveCinemachineBrainsinthescenewithoutgebneratinggarbage

Syntax

Parameters

indexType:SystemInt32Indexofthebraintoaccess,range0-BrainCount

ReturnValueType:CinemachineBrainThebrainatthespecifiedindex

publicCinemachineBrainGetActiveBrain(

intindex

CopyC# JavaScript

Cinemachine

CinemachineCoreGetVcamUpdateStatusMethod

Internaluseonly

Syntax

Parameters

vcamType:CinemachineICinemachineCamera[Missing<paramname="vcam"/>documentationfor"M:Cinemachine.CinemachineCore.GetVcamUpdateStatus(Cinemachine.ICinemachineCamera)"]

ReturnValueType:CinemachineCoreUpdateFilter[Missing<returns>documentationfor"M:Cinemachine.CinemachineCore.GetVcamUpdateStatus(Cinemachine.ICinemachineCamera)"]

publicCinemachineCoreUpdateFilterGetVcamUpdateStatus

CopyC# JavaScript

Cinemachine

CinemachineCoreGetVirtualCameraMethod

AccessthearrayofactiveICinemachineCamerainthescenewithoutgebneratinggarbage

Syntax

Parameters

indexType:SystemInt32Indexofthecameratoaccess,range0-VirtualCameraCount

ReturnValueType:ICinemachineCameraThevirtualcameraatthespecifiedindex

publicICinemachineCameraGetVirtualCamera(

intindex

CopyC# JavaScript

Cinemachine

CinemachineCoreIsLiveMethod

IsthisvirtualcameracurrentlyactivelycontrollinganyCamera?

Syntax

Parameters

vcamType:CinemachineICinemachineCamera[Missing<paramname="vcam"/>documentationfor"M:Cinemachine.CinemachineCore.IsLive(Cinemachine.ICinemachineCamera)"]

ReturnValueType:Boolean[Missing<returns>documentationfor"M:Cinemachine.CinemachineCore.IsLive(Cinemachine.ICinemachineCamera)"]

publicboolIsLive(

CopyC# JavaScript

Cinemachine

CinemachineCoreFields

GetInputAxis DelegateforoverridingUnity'sdefaultinputsystem.Ifyousetthis,thenyourdelegatewillbecalledinsteadofSystem.Input.GetAxis(axisName)wheneverin-gameuserinputisneeded.

kStreamingVersion Dataversionstring.Usedtoupgradefromlegacyprojects

kVersionString Human-readableCinemachineVersion

sShowHiddenObjects Iftrue,showhiddenCinemachineobjects,tomakemanualscriptmappingpossible.

Cinemachine

CinemachineCoreGetInputAxisField

DelegateforoverridingUnity'sdefaultinputsystem.Ifyousetthis,thenyourdelegatewillbecalledinsteadofSystem.Input.GetAxis(axisName)wheneverin-gameuserinputisneeded.

Syntax

FieldValueType:CinemachineCoreAxisInputDelegate

publicstaticCinemachineCoreAxisInputDelegateGetInputAxis

CopyC# JavaScript

Cinemachine

CinemachineCorekStreamingVersionField

Dataversionstring.Usedtoupgradefromlegacyprojects

Syntax

publicstaticreadonlyintkStreamingVersion

CopyC# JavaScript

Cinemachine

CinemachineCorekVersionStringField

Human-readableCinemachineVersion

Syntax

publicstaticreadonlystringkVersionString

CopyC# JavaScript

Cinemachine

CinemachineCoresShowHiddenObjectsField

Iftrue,showhiddenCinemachineobjects,tomakemanualscriptmappingpossible.

Syntax

publicstaticboolsShowHiddenObjects

CopyC# JavaScript

Cinemachine

CinemachineCoreAxisInputDelegateDelegate

DelegateforoverridingUnity'sdefaultinputsystem.Returnsthevalueofthenamedaxis.

Syntax

Parameters

axisNameType:SystemString

ReturnValueType:Single

publicdelegatefloatAxisInputDelegate(

stringaxisName

CopyC# JavaScript

Cinemachine

CinemachineCoreStageEnumeration

StagesintheCinemachineComponentpipeline,usedforUIorganization>.Thisenumdefinesthepipelineorder.

Syntax

Members

Body 0 Secondstage:positionthecamerainspace

Aim 1 Thirdstage:orientthecameratopointatthetarget

Noise 2 Finalstage:applynoise(thisisdoneseparately,intheCorrectionchanneloftheCameraState)

SeeAlso

publicenumStage

CopyC# JavaScript

Cinemachine

CinemachineCoreUpdateFilterEnumeration

Internaluseonly

Syntax

Fixed 0

Late 1

publicenumUpdateFilter

CopyC# JavaScript

Cinemachine

CinemachineDollyCartClass

ThisisaverysimplebehaviourthatconstrainsitstransformtoaCinemachinePath.Itcanbeusedtoanimateanyobjectsalongapath,orasaFollowtargetforCinemachineVirtualCameras.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineDollyCart

Syntax

TheCinemachineDollyCarttypeexposesthefollowingmembers.

CinemachineDollyCart

[ExecuteInEditMode]

publicclassCinemachineDollyCart:MonoBehaviour

CopyC# JavaScript

m_Path Thepathtofollow

m_Position Thecart'scurrentpositiononthepath,indistanceunits

m_PositionUnits HowtointerpretthePathPosition

m_Speed Movethecartwiththisspeed

m_UpdateMethod Whentomovethecart,ifVelocityisnon-zero

Cinemachine

CinemachineDollyCartConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineDollyCart.#ctor"]

Syntax

SeeAlsoReferenceCinemachineDollyCartClassCinemachineNamespace

publicCinemachineDollyCart()

CopyC# JavaScript

Cinemachine

CinemachineDollyCartFields

TheCinemachineDollyCarttypeexposesthefollowingmembers.

m_Path Thepathtofollow

m_Position Thecart'scurrentpositiononthepath,indistanceunits

m_Speed Movethecartwiththisspeed

m_UpdateMethod Whentomovethecart,ifVelocityisnon-zero

Cinemachine

CinemachineDollyCartm_PathField

Thepathtofollow

Syntax

FieldValueType:CinemachinePathBase

[TooltipAttribute("Thepathtofollow")]

publicCinemachinePathBasem_Path

CopyC# JavaScript

Cinemachine

CinemachineDollyCartm_PositionField

Thecart'scurrentpositiononthepath,indistanceunits

Syntax

[TooltipAttribute("Thepositionalongthepathatwhichthecartwillbeplaced.Thiscanbeanimateddirectlyor,ifthevelocityisnon-zero,willbeupdatedautomatically.ThevalueisinterpretedaccordingtothePositionUnitssetting.")]

[FormerlySerializedAsAttribute("m_CurrentDistance")]

publicfloatm_Position

CopyC# JavaScript

Cinemachine

CinemachineDollyCartm_PositionUnitsField

HowtointerpretthePathPosition

Syntax

FieldValueType:CinemachinePathBasePositionUnits

[TooltipAttribute("HowtointerpretthePathPosition.IfsettoPathUnits,valuesareasfollows:0representsthefirstwaypointonthepath,1isthesecond,andsoon.Valuesin-betweenarepointsonthepathinbetweenthewaypoints.IfsettoDistance,thenPathPositionrepresentsdistancealongthepath.")]

publicCinemachinePathBasePositionUnitsm_PositionUnits

CopyC# JavaScript

Cinemachine

CinemachineDollyCartm_SpeedField

Movethecartwiththisspeed

Syntax

[TooltipAttribute("Movethecartwiththisspeedalongthepath.ThevalueisinterpretedaccordingtothePositionUnitssetting.")]

[FormerlySerializedAsAttribute("m_Velocity")]

publicfloatm_Speed

CopyC# JavaScript

Cinemachine

CinemachineDollyCartm_UpdateMethodField

Whentomovethecart,ifVelocityisnon-zero

Syntax

FieldValueType:CinemachineDollyCartUpdateMethod

[TooltipAttribute("Whentomovethecart,ifVelocityisnon-zero")]

publicCinemachineDollyCartUpdateMethodm_UpdateMethod

CopyC# JavaScript

Cinemachine

CinemachineDollyCartUpdateMethodEnumeration

Syntax

Members

Update 0 UpdatedinnormalMonoBehaviourUpdate.

FixedUpdate 1 UpdatedinsyncwiththePhysicsmodule,inFixedUpdate

CopyC# JavaScript

Cinemachine

CinemachineExtensionClass

BaseclassforaCinemachineVirtualCameraextensionmodule.HooksintotheCinemachinePipeline.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineExtensionCinemachineCinemachineColliderCinemachineCinemachineConfinerCinemachineCinemachineFollowZoom

Syntax

TheCinemachineExtensiontypeexposesthefollowingmembers.

CinemachineExtension

publicabstractclassCinemachineExtension:MonoBehaviour

CopyC# JavaScript

Awake Connecttovirtualcamerapipeline.Overrideimplementationsmustcallthisbaseimplementation

GetAllExtraStatesT Ineffeicientmethodtogetallextrastateinforforallvcams.IntendedforEditoruseonly,notruntime!

GetExtraStateT Becauseextensionscanbeplacedonmanagercamsandwillinthatcasebecalledforallthevcamchildren,vcam-specificstateinformationshouldbestoredhere.Justdefineaclasstoholdyourstateinfoand

useitexclusivelywhencallingthis.

OnDestroy Disconnectfromvirtualcamerapipeline.Overrideimplementationsmustcallthisbaseimplementation

PostPipelineStageCallback Thiscallbackwillbecalledafterthevirtualcamerahasimplementedeachstageinthepipeline.Thismethodmaymodifythereferencedstate.IfdeltaTimelessthan0,resetallstateinfoandperformnodamping.

Cinemachine

CinemachineExtensionConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineExtension.#ctor"]

Syntax

SeeAlsoReferenceCinemachineExtensionClassCinemachineNamespace

protectedCinemachineExtension()

CopyC# JavaScript

Cinemachine

CinemachineExtensionProperties

Cinemachine

CinemachineExtensionVirtualCameraProperty

GettheassociatedCinemachineVirtualCameraBase

Syntax

publicCinemachineVirtualCameraBaseVirtualCamera{

CopyC# JavaScript

Cinemachine

CinemachineExtensionMethods

Awake Connecttovirtualcamerapipeline.Overrideimplementationsmustcallthisbaseimplementation

GetAllExtraStatesT Ineffeicientmethodtogetallextrastateinforforallvcams.IntendedforEditoruseonly,notruntime!

GetExtraStateT Becauseextensionscanbeplacedonmanagercamsandwillinthatcasebecalledforallthevcamchildren,vcam-specificstateinformationshouldbestoredhere.Justdefineaclasstoholdyourstateinfoanduseitexclusivelywhencallingthis.

OnDestroy Disconnectfrom

virtualcamerapipeline.Overrideimplementationsmustcallthisbaseimplementation

PostPipelineStageCallback Thiscallbackwillbecalledafterthevirtualcamerahasimplementedeachstageinthepipeline.Thismethodmaymodifythereferencedstate.IfdeltaTimelessthan0,resetallstateinfoandperformnodamping.

Cinemachine

CinemachineExtensionAwakeMethod

Connecttovirtualcamerapipeline.Overrideimplementationsmustcallthisbaseimplementation

Syntax

protectedvirtualvoidAwake()

CopyC# JavaScript

Cinemachine

CinemachineExtensionGetAllExtraStatesMethod

Ineffeicientmethodtogetallextrastateinforforallvcams.IntendedforEditoruseonly,notruntime!

Syntax

TypeParameters

ReturnValueType:ListT[Missing<returns>documentationfor"M:Cinemachine.CinemachineExtension.GetAllExtraStates``1"]

protectedList<T>GetAllExtraStates<T>()

whereT:class,new()

CopyC# JavaScript

Cinemachine

CinemachineExtensionGetExtraStateMethod

Becauseextensionscanbeplacedonmanagercamsandwillinthatcasebecalledforallthevcamchildren,vcam-specificstateinformationshouldbestoredhere.Justdefineaclasstoholdyourstateinfoanduseitexclusivelywhencallingthis.

Syntax

Parameters

vcamType:CinemachineICinemachineCamera[Missing<paramname="vcam"/>documentationfor"M:Cinemachine.CinemachineExtension.GetExtraState``1(Cinemachine.ICinemachineCamera)"]

TypeParameters

ReturnValueType:T[Missing<returns>documentationfor

protectedTGetExtraState<T>(

whereT:class,new()

CopyC# JavaScript

"M:Cinemachine.CinemachineExtension.GetExtraState``1(Cinemachine.ICinemachineCamera)"]

Cinemachine

CinemachineExtensionOnDestroyMethod

Disconnectfromvirtualcamerapipeline.Overrideimplementationsmustcallthisbaseimplementation

Syntax

protectedvirtualvoidOnDestroy()

CopyC# JavaScript

Cinemachine

CinemachineExtensionPostPipelineStageCallbackMethod

Thiscallbackwillbecalledafterthevirtualcamerahasimplementedeachstageinthepipeline.Thismethodmaymodifythereferencedstate.IfdeltaTimelessthan0,resetallstateinfoandperformnodamping.

Syntax

Parameters

vcamType:CinemachineCinemachineVirtualCameraBase[Missing<paramname="vcam"/>documentationfor"M:Cinemachine.CinemachineExtension.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

stageType:CinemachineCinemachineCoreStage[Missing<paramname="stage"/>documentationfor"M:Cinemachine.CinemachineExtension.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

protectedabstractvoidPostPipelineStageCallback(

floatdeltaTime

CopyC# JavaScript

Type:CinemachineCameraState[Missing<paramname="state"/>documentationfor"M:Cinemachine.CinemachineExtension.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

deltaTimeType:SystemSingle[Missing<paramname="deltaTime"/>documentationfor"M:Cinemachine.CinemachineExtension.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

Cinemachine

CinemachineExtensionFields

Cinemachine

CinemachineExtensionEpsilonField

Usefulconstantforverysmallfloats

Syntax

protectedconstfloatEpsilon=0.0001f

CopyC# JavaScript

Cinemachine

CinemachineExternalCameraClass

Thiscomponentwillexposeanon-cinemachinecameratothecinemachinesystem,allowingittoparticipateinblends.JustadditasacomponentalongsideanexistingUnityCameracomponent.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineVirtualCameraBaseCinemachineCinemachineExternalCamera

Syntax

TheCinemachineExternalCameratypeexposesthefollowingmembers.

[RequireComponent(typeof(Camera))]

[ExecuteInEditMode]

[AddComponentMenu("Cinemachine/CinemachineExternalCamera")]

publicclassCinemachineExternalCamera:CinemachineVirtualCameraBase

CopyC# JavaScript

CinemachineExternalCamera

Description Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo(InheritedfromCinemachineVirtualCameraBase

Follow Thisvcamdefinesnotargets(OverridesCinemachineVirtualCameraBase

LiveChildOrSelf Justreturnsself.(InheritedfromCinemachineVirtualCameraBase

LookAt Theobjectthatthecameraislookingat(OverridesCinemachineVirtualCameraBase

Name GetthenameoftheVirtualCamera.BaseimplementationreturnstheownerGameObject'sname.(InheritedfromCinemachineVirtualCameraBase

ParentCamera Supportformeta-virtual-cameras.thesituationwhereavirtualcameraisin

factthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.ThismethodgetstheVirtualCameraowner,ifany.PrivatearmiesareimplementedasTransformchildrenoftheparentvcam.(InheritedfromCinemachineVirtualCameraBase

Priority GetthePriorityofthevirtualcamera.ThisdeterminesitsplacementCinemachineCore'squeueofeligibleshots.(InheritedfromCinemachineVirtualCameraBase

State GettheCameraState,asweareabletoconstructonefromtheUnityCamera(OverridesCinemachineVirtualCameraBase

AddPostPipelineStageHook Adelegatetohookintothestatecalculationpipeline.becalledaftereachpipelinestage,toallowotherstohookintothepipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase

InvokePostPipelineStageCallback InvokesthePostPipelineStageDelegateforthiscamera,andupthehierarchyforallparentcameras(ifany).(InheritedfromCinemachineVirtualCameraBase

IsLiveChild Checkwhetherthevcamalivechildofthiscamera.classimplementationalwaysreturnsfalse.(InheritedfromCinemachineVirtualCameraBase

MoveToTopOfPrioritySubqueue Whenmultiplevirtualcamerashavethehighestpriority,thereissometimestheneedtopushonetothetop,makingitthecurrentLivecameraifitsharesthehighestpriorityinthequeuewithitspeers.Thishappensautomaticallywhenavcamisenabled:themostrecentonegoestothetopoftheprioritysubqueue.Usethismethodtopushavcamtothetopofitsprioritypeers.Ifitanditspeerssharethehighestpriority,thenthisvcamwillbecomeLive.(InheritedfromCinemachineVirtualCameraBase

OnEnable Baseclassimplementationaddsthevirtualcamerafromthepriorityqueue.(InheritedfromCinemachineVirtualCameraBase

OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.implementationmustbecalledbyanyoverriddenmethod.(InheritedfromCinemachineVirtualCameraBase

OnValidate Enforceboundsforfields,whenchangedininspector.baseclassimplementationatthebeginningofoverriddenmethod.Afterbasemethodiscalled,ValidatingStreamVersionwillbevalid.(InheritedfromCinemachineVirtualCameraBase

PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,inordertoallowtheparenttoprepareitschildren.thechildrenareupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledpriortoeveryFixedUpdate,butitmightbecalledonLateUpdateinstead.doesnothing.(InheritedfromCinemachineVirtualCameraBase

RemovePostPipelineStageHook RemoveaPipelinestagehookcallback.(InheritedfromCinemachineVirtualCameraBase

ResolveFollow Returnsthisvcam'sFollowtarget,orifthatisnull,willretruntheparentvcam'sFollowtarget.(InheritedfromCinemachineVirtualCameraBase

ResolveLookAt Returnsthisvcam'sLookAttarget,orifthatisnull,willretruntheparentvcam'sLookAttarget.(InheritedfromCinemachineVirtualCameraBase

UpdateCameraState ConstructaCameraStateobjectfromtheUnityCamera(OverridesCinemachineVirtualCameraBaseSingle).)

m_LookAt Theobjectthatthecameraislookingat.

Cinemachine

CinemachineExternalCameraConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineExternalCamera.#ctor"]

Syntax

SeeAlsoReferenceCinemachineExternalCameraClassCinemachineNamespace

publicCinemachineExternalCamera()

CopyC# JavaScript

Cinemachine

CinemachineExternalCameraProperties

Follow Thisvcamdefinesnotargets(OverridesCinemachineVirtualCameraBase

LookAt Theobjectthatthecameraislookingat(OverridesCinemachineVirtualCameraBase

ParentCamera Supportformeta-virtual-cameras.

thesituationwhereavirtualcameraisinfactthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.ThismethodgetstheVirtualCameraowner,ifany.PrivatearmiesareimplementedasTransformchildrenoftheparentvcam.(InheritedfromCinemachineVirtualCameraBase

State GettheCameraState,asweareabletoconstructonefromtheUnityCamera(OverridesCinemachineVirtualCameraBase

Cinemachine

CinemachineExternalCameraFollowProperty

Thisvcamdefinesnotargets

Syntax

CopyC# JavaScript

Cinemachine

CinemachineExternalCameraLookAtProperty

Theobjectthatthecameraislookingat

Syntax

CopyC# JavaScript

Cinemachine

CinemachineExternalCameraStateProperty

GettheCameraState,asweareabletoconstructonefromtheUnityCamera

Syntax

CopyC# JavaScript

Cinemachine

CinemachineExternalCameraMethods

AddPostPipelineStageHook Adelegatetohookintothestatecalculationpipeline.becalledaftereachpipelinestage,toallowotherstohookintothepipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase

InvokePostPipelineStageCallback InvokesthePostPipelineStageDelegateforthiscamera,andupthehierarchyforallparentcameras(ifany).(InheritedfromCinemachineVirtualCameraBase

IsLiveChild Checkwhetherthevcamalivechildofthiscamera.classimplementationalwaysreturnsfalse.(InheritedfromCinemachineVirtualCameraBase

MoveToTopOfPrioritySubqueue Whenmultiplevirtualcamerashavethehighestpriority,thereissometimestheneedtopushonetothetop,makingitthecurrentLivecameraifitsharesthehighestpriorityinthequeuewithitspeers.Thishappensautomaticallywhenavcamisenabled:themostrecentonegoestothetopoftheprioritysubqueue.Usethismethodtopushavcamtothetopofitsprioritypeers.Ifitanditspeerssharethehighestpriority,thenthisvcamwillbecomeLive.(InheritedfromCinemachineVirtualCameraBase

OnDestroy Baseclassimplementationremovesthevirtualcamerafromthepriorityqueue.