Selfie Mode

Players already take screenshots to commemorate fun moments in experiences. The SelfieMode developer module lets players capture a cleaner memory of that moment without the chat window or player list, while also supporting filter effects, hiding of other characters, and posing.

Module Usage

Installation

To use the SelfieMode module in an experience:

1. From the View tab, open the Toolbox and select the Creator Store tab.

   

2. Make sure the Models sorting is selected, then click the See All button for Categories.

   

3. Locate and click the Dev Modules tile.

   

4. Locate the Selfie Mode module and click it, or drag-and-drop it into the 3D view.

   

5. In the Explorer window, move the entire SelfieMode model into ServerScriptService. Upon running the experience, the module will distribute itself to various services and begin running.

   

Configuration

The module is preconfigured to work for most use cases, but you can easily customize it through the configure function.

1. In StarterPlayerScripts, create a new LocalScript and rename it to ConfigureSelfieMode.

2. Paste the following code into the new script.

   LocalScript - ConfigureSelfieMode
   local ReplicatedStorage = game:GetService("ReplicatedStorage")
   
   local SelfieMode = require(ReplicatedStorage:WaitForChild("SelfieMode"))
   
   SelfieMode.configure({
   	disableCharacterMovement = true
   })

Character Movement

It may be advantageous to prevent the player's character from moving while in selfie mode. You can achieve this by setting disableCharacterMovement to true in a configure call.

LocalScript - ConfigureSelfieMode
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local SelfieMode = require(ReplicatedStorage:WaitForChild("SelfieMode"))

SelfieMode.configure({
	disableCharacterMovement = true
})

Selfie Mode Actions

SelfieMode comes with the following actions, each of which you can use with the activateAction, deactivateAction, and toggleAction functions, or detect through the actionActivated and actionDeactivated events.

Depth-of-Field

By default, SelfieMode shows a generic depth‑of‑field effect (subtle blur of the background) when a player toggles the action.

To change the default depth‑of‑field effect, set depthOfFieldEffect to your own DepthOfFieldEffect instance in a configure call.

LocalScript - ConfigureSelfieMode
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local SelfieMode = require(ReplicatedStorage:WaitForChild("SelfieMode"))

local customDepthOfField = Instance.new("DepthOfFieldEffect")
customDepthOfField.NearIntensity = 0
customDepthOfField.FarIntensity = 1
customDepthOfField.FocusDistance = 5
customDepthOfField.InFocusRadius = 5

SelfieMode.configure({
	depthOfFieldEffect = customDepthOfField
})

Lock Gaze

The Lock Gaze toggle causes the player's character to look at the camera while setting up the selfie pose, within a realistic range of how far their neck can turn.

Hide Others

By default, other characters are visible alongside the player's character. Players can obtain a perfect solo shot by clicking the Hide Others button. When toggled on, other characters fade out of view and remain invisible until the action is toggled off.

Filter

The Filter action lets the player apply a preset filter from the options Pop, Soft, Antique, Cute, Dramatic, and Monochrome.

Pose

The Pose action lets the player select a preset pose from the options Cheer, Clapping, Dolphin, Flossing, Guitar, Jump Wave, Louder, Top Rock, Twirl, and Wave.

API Reference

Types

Action

Each action is represented by a dictionary with the following key-value pairs:

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local SelfieMode = require(ReplicatedStorage:WaitForChild("SelfieMode"))

SelfieMode.actionActivated:Connect(function(action)
	print(action.name, "activated")
end)

SelfieMode.actionDeactivated:Connect(function(action)
	print(action.name, "deactivated")
end)

Enums

SelfieMode.Action

SelfieMode comes with several actions. You can use this enum with the activateAction, deactivateAction, and toggleAction functions.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local SelfieMode = require(ReplicatedStorage:WaitForChild("SelfieMode"))

-- Activate "Filter" action
SelfieMode.activateAction(SelfieMode.Action.Filter)

Functions

configure

Overrides default configuration options through the following keys/values in the config table. This function can only be called from a LocalScript.

LocalScript - ConfigureSelfieMode
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local SelfieMode = require(ReplicatedStorage:WaitForChild("SelfieMode"))

SelfieMode.configure({
	disableCharacterMovement = true
})

openSelfieMode

A player will typically open selfie mode with the "camera" button on the right side of the screen, but this function lets you open it through code. When implementing a custom button as shown below, you should disable the default button through setHudButtonEnabled. This function can only be called from a LocalScript.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local SelfieMode = require(ReplicatedStorage:WaitForChild("SelfieMode"))

local button = script.Parent

-- Remove the default button
SelfieMode.setHudButtonEnabled(false)

-- Connect the custom button
button.Activated:Connect(function()
	SelfieMode.openSelfieMode()
end)

closeSelfieMode

A player will typically close selfie mode with the ⊗ button at the bottom of the screen, but this function lets you close it through code. Can only be called from a LocalScript.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local SelfieMode = require(ReplicatedStorage:WaitForChild("SelfieMode"))

SelfieMode.closeSelfieMode()

isSelfieModeOpen

Returns true if selfie mode is open as a result of player action or through openSelfieMode. This function can only be called from a LocalScript.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local SelfieMode = require(ReplicatedStorage:WaitForChild("SelfieMode"))

SelfieMode.openSelfieMode()

print(SelfieMode.isSelfieModeOpen())

setHudButtonEnabled

Sets whether the default button to enter selfie mode is shown. Useful when implementing openSelfieMode through a custom UI button. This function can only be called from a LocalScript.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local SelfieMode = require(ReplicatedStorage:WaitForChild("SelfieMode"))

local button = script.Parent

-- Remove the default button
SelfieMode.setHudButtonEnabled(false)

-- Connect the custom button
button.Activated:Connect(function()
	SelfieMode.openSelfieMode()
end)

getAction

Gets an Action type through a SelfieMode.Action enum.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local SelfieMode = require(ReplicatedStorage:WaitForChild("SelfieMode"))

local lockGazeAction = SelfieMode.getAction(SelfieMode.Action.LockGaze)

activateAction

Programmatically activates one of the default actions. This is the same as when a player toggles the action on from the action bar. Can only be called from a LocalScript.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local SelfieMode = require(ReplicatedStorage:WaitForChild("SelfieMode"))

-- Activate "Filter" action
SelfieMode.activateAction(SelfieMode.Action.Filter)

deactivateAction

Programmatically deactivates one of the default actions. This is the same as when a player toggles the action off from the action bar. Can only be called from a LocalScript.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local SelfieMode = require(ReplicatedStorage:WaitForChild("SelfieMode"))

-- Deactivate "Filter" action
SelfieMode.deactivateAction(SelfieMode.Action.Filter)

toggleAction

Toggles an action on if it's off, or toggles it off if it's on. This is the same as when a player clicks the action from the action bar. Returns the new "is toggled on" state as a boolean. Can only be called from a LocalScript.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local SelfieMode = require(ReplicatedStorage:WaitForChild("SelfieMode"))

local lockGazeAction = SelfieMode.getAction(SelfieMode.Action.LockGaze)

local isEnabled = SelfieMode.toggleAction(lockGazeAction)

if isEnabled then
	print("Activated", lockGazeAction.name)
else
	print("Deactivated", lockGazeAction.name)
end

setTheme

Configures the selfie mode theme, including text size, font, button/tooltip colors, and more. This function can only be called from a LocalScript.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local SelfieMode = require(ReplicatedStorage:WaitForChild("SelfieMode"))

SelfieMode.setTheme({
	textSize = 20,
	font = Enum.Font.Michroma,
	backgroundColor = Color3.fromRGB(0, 40, 75),
})

setEnabled

Sets whether selfie mode is enabled or not. When disabled, all UI for the module is removed and all events are disconnected. This function can only be called from a LocalScript.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local SelfieMode = require(ReplicatedStorage:WaitForChild("SelfieMode"))

SelfieMode.setEnabled(false)

Events

selfieModeOpened

Fires when the player opens selfie mode or when openSelfieMode is called. This event can only be connected in a LocalScript.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local SelfieMode = require(ReplicatedStorage:WaitForChild("SelfieMode"))

SelfieMode.selfieModeOpened:Connect(function()
	print("Selfie mode open")
end)

selfieModeClosed

Fires when the player closes selfie mode or when closeSelfieMode is called. This event can only be connected in a LocalScript.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local SelfieMode = require(ReplicatedStorage:WaitForChild("SelfieMode"))

SelfieMode.selfieModeClosed:Connect(function()
	print("Selfie mode closed")
end)

actionActivated

Fires when an action is activated; this may be one of the primary actions like Depth of Field, Lock Gaze, or Hide Others; alternatively it may be a sub-action like a filter or pose. The connected function receives the activated Action. This event can only be connected in a LocalScript.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local SelfieMode = require(ReplicatedStorage:WaitForChild("SelfieMode"))

SelfieMode.actionActivated:Connect(function(action)
	print(action.name, "activated")
end)

actionDeactivated

Fires when a primary action or sub-action is deactivated. The connected function receives the deactivated Action. This event can only be connected in a LocalScript.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local SelfieMode = require(ReplicatedStorage:WaitForChild("SelfieMode"))

SelfieMode.actionDeactivated:Connect(function(action)
	print(action.name, "deactivated")
end)

filterChanged

Fires when a filter is applied or removed. The connected function receives the new filter name and the old filter name. This event can only be connected in a LocalScript.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local SelfieMode = require(ReplicatedStorage:WaitForChild("SelfieMode"))

SelfieMode.filterChanged:Connect(function(newFilter, oldFilter)
	print("Filter changed from", oldFilter, "to", newFilter)
end)

poseChanged

Fires when a pose is applied or removed. The connected function receives the new pose name and the old pose name. This event can only be connected in a LocalScript.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local SelfieMode = require(ReplicatedStorage:WaitForChild("SelfieMode"))

SelfieMode.poseChanged:Connect(function(newPose, oldPose)
	print("Pose changed from", oldPose, "to", newPose)
end)