Skip to main content

Blueprint reference

Everything here is also available in C++. Nothing in this framework is C++-only.

The short way — ED Mounting library​

Static nodes with the component lookup and the null checks folded in.

Node
Try Mount NearestGet into whatever is nearest. Two exec pins: Succeeded, Failed.
Try MountGet into a specific actor.
Try DismountGet out.
Toggle MountIn if out, out if in. What a single key wants.
Get Rider Component / Get Mountable Component
Is MountableWhether an actor can be ridden right now.
Is Mounted / Is Seated / Is Driving MountWithout a cast.
Get Mount Phase / Get Mount Actor / Get Seat Role / Get Occupied Seat
Find Nearest MountThe full query, for an interaction prompt.
Make Default Mount QueryA query with the defaults filled in.
Get Failure TextLocalised text for any failure reason.
Get Seat NameA seat's authored name, for UI.
Is Valid Seat Handle / Equal (Seat Handle) / To String (Seat Handle)

ED Rider component​

Requests​

Node
Request MountGet into an actor; the framework picks the seat and the door.
Request Mount With OptionsThe same with a full Mount Request struct.
Request Mount NearestRuns the registry query and mounts the winner.
Request Dismount
Request Change SeatTo a specific handle.
Request Shuffle SeatTo the next free seat, wrapping.
Force DismountAuthority only. Put the rider down now, animation or not.
Apply Drive InputForward steering, throttle, brake and handbrake. Driver's seat only.
Handle Mount EventDrive a transition moment yourself.

The rider's own offset​

NodeDoes
Set Seated OffsetAn extra transform on top of the seat, for this rider. Replicated.
Get Seated OffsetWhat it is now.

State​

Get Mount Phase, Is Mounted, Is Seated, Is Transitioning, Is Driver, Get Mount Actor, Get Seat Handle, Get Entry Tag, Get Mountable, Get Seat Component, Get Seat Camera Component.

Events​

EventFires
On Mount Phase ChangedEverywhere, including simulated proxies.
On Mount FailedOnly where the request was made.
On Mount EventOn every named transition moment.

Properties​

Animation Set, Transition Mode, Default Query.

ED Mountable component​

Seats​

Get Seat Handles, Get Num Seats, Get Num Occupied Seats, Get Seat Component, Find Seat By Name, Get Driver Seat, Get Occupant, Find Seat Of, Get Driver, Get Riders, Is Seat Free, Has Free Seat, Get Seat World Transform.

Seats at runtime​

NodeDoes
Add SeatCreates a seat on the mount and returns it. Authority only.
Remove SeatDestroys a seat added at runtime; its occupant is put on the ground. Authority only.

Linked mounts​

NodeDoes
Link To MountMakes this mount part of another. False for a cycle or a non-mount. Authority only.
Unlink From MountStands alone again. Authority only.
Get Linked RootThe vehicle this is part of. Itself when it is not part of anything.
Get Linked MountablesEvery mount in the set, root first.
Is Linked ToWhether another actor is part of the same set.
Get Linked DriverWhoever is steering the whole thing.
Get Linked RidersEveryone aboard anything in the set.
Find Linked Seat ForA free seat anywhere in the set, and the mount that owns it.
Eject All Riders In Linked SetEverybody out, of everything. Authority only.

See Linked mounts.

Rules​

Node
Can Rider Use SeatEverything short of the distance check, with the reason.
Find Best Seat ForThe seat a rider should get when they did not name one.

State​

Is Mountable, Set Mountable (authority only), Get Mount Distance, Eject All Riders.

Events​

On Seat Occupancy Changed, On Mount Event, On Mountable Changed.

Properties​

Mount Tags, Mount Distance Override, Mount Animation Set, Eject Riders On Destroy.

ED Mount Point (Seat) component​

Properties are listed in Seats. Nodes:

Get Seat Handle, Get Mountable, Get Seat Transform, Get Effective Seat Name, Is Driver Seat, Get Effective Entry Points, Get Entry Point Transform, Find Best Entry Point, Is Entry Point Clear, Resolve Animation Set, Resolve Rider Policy, Resolve Possession Policy, Get Seat Camera Component, Derive Side Tag.

Interfaces​

Add them under Class Settings → Interfaces.

ED Mountable Interface — on the thing being ridden​

Event
Can Accept RiderThe last word on whether this rider may take this seat. Runs on the server too.
On Rider Seated / On Rider LeftAuthority only. Where gameplay state changes belong.
Set Seat Door OpenCalled by door notifies, on every machine.
Apply Driver InputSteering, throttle, brake, handbrake from the driver's seat.

ED Rider Interface — on the pawn​

Event
Get Rider TagsWhat a locked seat's query runs against.
Get Rider MeshWhich mesh the montage plays on. Defaults to the first skeletal mesh.
On Mount Phase ChangedThe same information as the delegate, as an overridable event.

All have working defaults. Implementing the interface is something you do when you want to change an answer, never something the framework requires.

Structs​

Struct
Mount RequestMount actor, desired seat, preferred entry, fallback, driver preference, instant, context tags.
Mount ResultSuccess, failure reason, seat, entry tag.
Seat HandleThe one way to name a seat.
Entry PointA door: transform, side, priority, clearance, ground rules.
Mount QueryDistance, view angle, free-seat and reachability requirements, a tag query.
Mount CandidateA query result: mount, seat, entry tag, distance, score.
Rider PolicyCollision, movement, replication, mesh, pose.
Procedural TransitionDuration, arc, easing curve, rotation.

Enums​

Mount Phase, Mount Failure, Transition Mode, Possession Policy, Rider Collision Policy.