[Modding] How to use Expansion Notification

How does it work ?

Some examples:

ExpansionNotification("Title Text", "My notification message").Success(identity);  // Example for a success message in expansion
ExpansionNotification("Title Text", "My notification message").Fail(identity);     // Example for a fail message in expansion
ExpansionNotification("Title Text", "My notification message").Info(identity);     // Example for a info message in expansion

// Examples for a message where you can controll color/icon and the time how long the message gets displayed
ExpansionNotification(new StringLocaliser("Title Text"), new StringLocaliser("My notification message"), ExpansionIcons.GetPath("Boat"), COLOR_EXPANSION_NOTIFICATION_MISSION, time).Create(identity); // Format to use the Expansion StringLocaliser

ExpansionNotification("Title Text", "My notification message", ExpansionIcons.GetPath("Boat"), COLOR_EXPANSION_NOTIFICATION_MISSION, time).Create(identity);  // Format to use normal string text

ICON

The icon need to be in a edds or paa format. Expansion provide by default 165 icons you can use with these static path definitions:

EXPANSION_NOTIFICATION_ICON_POSITION
EXPANSION_NOTIFICATION_ICON_ERROR
EXPANSION_NOTIFICATION_ICON_CAR
EXPANSION_NOTIFICATION_ICON_GROUP
EXPANSION_NOTIFICATION_ICON_TERRITORY
EXPANSION_NOTIFICATION_ICON_AIRDROP
EXPANSION_NOTIFICATION_ICON_DELIVER
EXPANSION_NOTIFICATION_ICON_RADIATION
EXPANSION_NOTIFICATION_ICON_TRADER
EXPANSION_NOTIFICATION_ICON_WATER_1
EXPANSION_NOTIFICATION_ICON_INFECTED_1
EXPANSION_NOTIFICATION_ICON_INFECTED_2
EXPANSION_NOTIFICATION_ICON_SKULL_1
EXPANSION_NOTIFICATION_ICON_HELI
EXPANSION_NOTIFICATION_ICON_HOME
EXPANSION_NOTIFICATION_ICON_BOAT
EXPANSION_NOTIFICATION_ICON_FISHING
EXPANSION_NOTIFICATION_ICON_VEHICLE_CRASH
EXPANSION_NOTIFICATION_ICON_MAP_MARKER
EXPANSION_NOTIFICATION_ICON_BEAR
EXPANSION_NOTIFICATION_ICON_CLAW
EXPANSION_NOTIFICATION_ICON_CROSS
EXPANSION_NOTIFICATION_ICON_DRIP
EXPANSION_NOTIFICATION_ICON_EAR
EXPANSION_NOTIFICATION_ICON_EYE
EXPANSION_NOTIFICATION_ICON_FIREPLACE
EXPANSION_NOTIFICATION_ICON_HEART
EXPANSION_NOTIFICATION_ICON_HOOK
EXPANSION_NOTIFICATION_ICON_INFO
EXPANSION_NOTIFICATION_ICON_KNIFE
EXPANSION_NOTIFICATION_ICON_MARKER
EXPANSION_NOTIFICATION_ICON_MENU
EXPANSION_NOTIFICATION_ICON_MOON
EXPANSION_NOTIFICATION_ICON_PEN
EXPANSION_NOTIFICATION_ICON_PERSONA
EXPANSION_NOTIFICATION_ICON_PILL
EXPANSION_NOTIFICATION_ICON_QUESTIONMARK
EXPANSION_NOTIFICATION_ICON_SKULL_2
EXPANSION_NOTIFICATION_ICON_SKULL_3
EXPANSION_NOTIFICATION_ICON_STAR
EXPANSION_NOTIFICATION_ICON_SUN
EXPANSION_NOTIFICATION_ICON_TENT
EXPANSION_NOTIFICATION_ICON_THERMOMETER
EXPANSION_NOTIFICATION_ICON_WATER_2
EXPANSION_NOTIFICATION_ICON_BOOK_1
EXPANSION_NOTIFICATION_ICON_BOOK_2
EXPANSION_NOTIFICATION_ICON_ELLIPSE
EXPANSION_NOTIFICATION_ICON_GRAB
EXPANSION_NOTIFICATION_ICON_HAND_OPEN
EXPANSION_NOTIFICATION_ICON_MAP
EXPANSION_NOTIFICATION_ICON_NOTE
EXPANSION_NOTIFICATION_ICON_ORIENTATION
EXPANSION_NOTIFICATION_ICON_RADIO
EXPANSION_NOTIFICATION_ICON_SHIELD
EXPANSION_NOTIFICATION_ICON_SNOW
EXPANSION_NOTIFICATION_ICON_ARROW
EXPANSION_NOTIFICATION_ICON_BATTERY_FULL
EXPANSION_NOTIFICATION_ICON_BATTERY_MED
EXPANSION_NOTIFICATION_ICON_BATTERY_LOW
EXPANSION_NOTIFICATION_ICON_BATTERY_EMPTY
EXPANSION_NOTIFICATION_ICON_3D_ON
EXPANSION_NOTIFICATION_ICON_3D_OFF
EXPANSION_NOTIFICATION_ICON_2D_ON
EXPANSION_NOTIFICATION_ICON_2D_OFF
EXPANSION_NOTIFICATION_ICON_T_Animal_Skull
EXPANSION_NOTIFICATION_ICON_T_Apple
EXPANSION_NOTIFICATION_ICON_T_Apple_Core
EXPANSION_NOTIFICATION_ICON_T_Arrows
EXPANSION_NOTIFICATION_ICON_T_Axe
EXPANSION_NOTIFICATION_ICON_T_BagPack
EXPANSION_NOTIFICATION_ICON_T_Bandage
EXPANSION_NOTIFICATION_ICON_T_Batteries
EXPANSION_NOTIFICATION_ICON_T_Berries
EXPANSION_NOTIFICATION_ICON_T_Big_Kitchen_Knife
EXPANSION_NOTIFICATION_ICON_T_Binoculars
EXPANSION_NOTIFICATION_ICON_T_Bolt
EXPANSION_NOTIFICATION_ICON_T_Bonfire
EXPANSION_NOTIFICATION_ICON_T_Bottle
EXPANSION_NOTIFICATION_ICON_T_Bow
EXPANSION_NOTIFICATION_ICON_T_BrokenLighter
EXPANSION_NOTIFICATION_ICON_T_Can_Of_Beans_Big
EXPANSION_NOTIFICATION_ICON_T_Can_Of_Beans_Small
EXPANSION_NOTIFICATION_ICON_T_Car_Keys
EXPANSION_NOTIFICATION_ICON_T_Carrot
EXPANSION_NOTIFICATION_ICON_T_Chain_Saw
EXPANSION_NOTIFICATION_ICON_T_Chicken
EXPANSION_NOTIFICATION_ICON_T_Chocolate
EXPANSION_NOTIFICATION_ICON_T_Cigarets
EXPANSION_NOTIFICATION_ICON_T_Cloth
EXPANSION_NOTIFICATION_ICON_T_Collection_of_bolts
EXPANSION_NOTIFICATION_ICON_T_Collection_Of_Sticks_01
EXPANSION_NOTIFICATION_ICON_T_Collection_Of_Sticks_02
EXPANSION_NOTIFICATION_ICON_T_Collection_Of_Sticks_03
EXPANSION_NOTIFICATION_ICON_T_Collection_Of_Sticks_04
EXPANSION_NOTIFICATION_ICON_T_Compass
EXPANSION_NOTIFICATION_ICON_T_Cooked_Meat_01
EXPANSION_NOTIFICATION_ICON_T_Cooked_Meat_02
EXPANSION_NOTIFICATION_ICON_T_Cooked_Meat_03
EXPANSION_NOTIFICATION_ICON_T_Corn
EXPANSION_NOTIFICATION_ICON_T_Crowbar
EXPANSION_NOTIFICATION_ICON_T_Cow
EXPANSION_NOTIFICATION_ICON_T_Dinosaur_Skull
EXPANSION_NOTIFICATION_ICON_T_Dry_Wood
EXPANSION_NOTIFICATION_ICON_T_EatableFlowers
EXPANSION_NOTIFICATION_ICON_T_ElectricalTape
EXPANSION_NOTIFICATION_ICON_T_Empty_Can
EXPANSION_NOTIFICATION_ICON_T_Fish
EXPANSION_NOTIFICATION_ICON_T_Flare
EXPANSION_NOTIFICATION_ICON_T_FlareGun
EXPANSION_NOTIFICATION_ICON_T_FlareGunAmmo
EXPANSION_NOTIFICATION_ICON_T_Flashlight
EXPANSION_NOTIFICATION_ICON_T_Fox
EXPANSION_NOTIFICATION_ICON_T_Frying_Pan
EXPANSION_NOTIFICATION_ICON_T_Gas
EXPANSION_NOTIFICATION_ICON_T_GasMask
EXPANSION_NOTIFICATION_ICON_T_Golf_club
EXPANSION_NOTIFICATION_ICON_T_Goose
EXPANSION_NOTIFICATION_ICON_T_Grenade
EXPANSION_NOTIFICATION_ICON_T_Guitar
EXPANSION_NOTIFICATION_ICON_T_Gun
EXPANSION_NOTIFICATION_ICON_T_Gun_Bullets
EXPANSION_NOTIFICATION_ICON_T_Hammer
EXPANSION_NOTIFICATION_ICON_T_HerbalMedicine
EXPANSION_NOTIFICATION_ICON_T_HomeMadeGrenade
EXPANSION_NOTIFICATION_ICON_T_HumanSkull
EXPANSION_NOTIFICATION_ICON_T_Insect
EXPANSION_NOTIFICATION_ICON_T_Kitchen_Knife
EXPANSION_NOTIFICATION_ICON_T_Ladder
EXPANSION_NOTIFICATION_ICON_T_Lantern
EXPANSION_NOTIFICATION_ICON_T_Lighter
EXPANSION_NOTIFICATION_ICON_T_Lizard
EXPANSION_NOTIFICATION_ICON_T_Machette
EXPANSION_NOTIFICATION_ICON_T_Map
EXPANSION_NOTIFICATION_ICON_T_Matches
EXPANSION_NOTIFICATION_ICON_T_Medic_Box
EXPANSION_NOTIFICATION_ICON_T_Molotov
EXPANSION_NOTIFICATION_ICON_T_Mushrooms
EXPANSION_NOTIFICATION_ICON_T_Nails
EXPANSION_NOTIFICATION_ICON_T_Paper
EXPANSION_NOTIFICATION_ICON_T_Pills
EXPANSION_NOTIFICATION_ICON_T_Pipe_wrench
EXPANSION_NOTIFICATION_ICON_T_Powder
EXPANSION_NOTIFICATION_ICON_T_Pumpkin
EXPANSION_NOTIFICATION_ICON_T_Rabbit
EXPANSION_NOTIFICATION_ICON_T_Raccon
EXPANSION_NOTIFICATION_ICON_T_Radio
EXPANSION_NOTIFICATION_ICON_T_Rat
EXPANSION_NOTIFICATION_ICON_T_Rock_01
EXPANSION_NOTIFICATION_ICON_T_Rock_02
EXPANSION_NOTIFICATION_ICON_T_Rope
EXPANSION_NOTIFICATION_ICON_T_Saw
EXPANSION_NOTIFICATION_ICON_T_Scrap_Metal
EXPANSION_NOTIFICATION_ICON_T_Screwdriver
EXPANSION_NOTIFICATION_ICON_T_Shotgun
EXPANSION_NOTIFICATION_ICON_T_Shotgun_Bullets
EXPANSION_NOTIFICATION_ICON_T_Shovel
EXPANSION_NOTIFICATION_ICON_T_Sleeping_Bag
EXPANSION_NOTIFICATION_ICON_T_Slingshot
EXPANSION_NOTIFICATION_ICON_T_Soda
EXPANSION_NOTIFICATION_ICON_T_Tent
EXPANSION_NOTIFICATION_ICON_T_Three_Stick
EXPANSION_NOTIFICATION_ICON_T_Walkie_Talkie
EXPANSION_NOTIFICATION_ICON_T_WaterJug
EXPANSION_NOTIFICATION_ICON_T_WildPork
EXPANSION_NOTIFICATION_ICON_T_Worms

You can also use the Expansions icon system in this case:

ExpansionIcons.GetPath("Boat")

"Arrow"
"Error"
"Airdrop"
"Car"
"Deliver"
"Radiation"
"Trader"
"Water 1"
"Infected 1"
"Infected 2"
"Skull 1"
"Helicopter"
"Base"
"Boat"
"Fishing"
"Territory"
"Bear"
"Claw"
"Drip"
"Ear"
"Eye"
"Fireplace"
"Heart"
"Hook"
"Info"
"Knife"
"Marker"
"Map Marker"
"Menu"
"Moon"
"Pen"
"Persona"
"Pill"
"Questionmark"
"Skull 2"
"Skull 3"
"Star"
"Sun"
"Tent"
"Thermometer"
"Water 2"
"Book 1"
"Book 2"
"Ellipse"
"Square"
"Grab"
"Open Hand"
"Map"
"Note"
"Orientation"
"Radio"
"Shield"
"Snow"
"Group"
"Vehicle Crash"

"Animal Skull"
"Apple"
"Apple Core"
"Arrows"
"Axe"
"Backpack"
"Bandage"
"Batteries"
"Berries"
"Kitchen Knife Big"
"Binoculars"
"Bolt"
"Bonfire"
"Bottle"
"Bow"
"Broken Lighter"
"Can Of Beans Big"
"Can Of Beans Small"
"Car Keys"
"Carrot"
"Chain Saw"
"Chicken"
"Chocolate"
"Cigarets"
"Cloth"
"Compass"
"Corn"
"Crowbar"
"Cow"
"Dinosaur Skull"
"Dry Wood"
"Eatable Flowers"
"Electrical Tape"
"Empty Can"
"Fish"
"Flare"
"Flare Gun"
"Flare Gun Ammo"
"Flashlight"
"Fox"
"Frying Pan"
"Gas"
"Gas Mask"
"Golf Club"
"Goose"
"Grenade"
"Guitar"
"Gun"
"Gun Bullets"
"Hammer"
"Herbal Medicine"
"Home Made Grenade"
"Human Skull"
"Insect"
"Kitchen Knife"
"Ladder"
"Lantern"
"Lighter"
"Machette"
"Paper Map"
"Matches"
"Medic Box"
"Mushrooms"
"Nails"
"Paper"
"Pills"
"Pipe Wrench"
"Powder"
"Pumpkin"
"Rabbit"
"Racoon"
"Radio"
"Rat"
"Rock 1"
"Rock 2"
"Rope"
"Saw"
"Scrap Metal"
"Screwdriver"
"Shotgun"
"Shotgun Bullets"
"Shovel"
"Soda"
"Tent Small"
"Walkie Talkie"
"Water Jug"
"Wild Pork"
"Worms"

"Discord"
"Reddit"
"Steam"
"GitHub"
"Homepage"
"Forums"
"Twitter"
"YouTube"
"Patreon"
"Guilded"

COLOR

The color must be in ARGB. By default expansion have 14 colors configured but you can also use this site to generate any kind of color integer for your color: https://argb-int-calculator.netlify.app/

COLOR_EXPANSION_ITEM_HIGHLIGHT_TEXT
COLOR_EXPANSION_ITEM_NORMAL_TEXT
COLOR_EXPANSION_ITEM_HIGHLIGHT_ELEMENT
COLOR_EXPANSION_ITEM_NORMAL_ELEMENT
COLOR_EXPANSION_NOTIFICATION_INFO
COLOR_EXPANSION_NOTIFICATION_ERROR
COLOR_EXPANSION_NOTIFICATION_SUCCSESS
COLOR_EXPANSION_NOTIFICATION_ORANGE
COLOR_EXPANSION_NOTIFICATION_ASPHALT
COLOR_EXPANSION_NOTIFICATION_AMETHYST
COLOR_EXPANSION_NOTIFICATION_TURQUOISE
COLOR_EXPANSION_NOTIFICATION_ORANGEVILLE
COLOR_EXPANSION_NOTIFICATION_EXPANSION
COLOR_EXPANSION_NOTIFICATION_MISSION

TIMER

The timer is a simple integrer (int) number. This value is the amount of seconds it will stay on the screen of the player. We recommend you to use a number between 5 and 10.

PLAYER_IDENTITY

You need to enter the player identity to send him the notification. In offline mode you can target your own player with this two lines:

PlayerBase player;
GetGame().SelectPlayer( NULL, player );

(Obviously this will create issues in multiplayer if you use the same method)

and send a notification to yourself in your code with

GetNotificationSystem().CreateNotification( new StringLocaliser( "HELLO WORLD" ), new StringLocaliser( "Let's go to another quest !" ), EXPANSION_NOTIFICATION_ICON_ERROR, COLOR_EXPANSION_NOTIFICATION_ERROR, 5, player.GetIdentity() );

If you want to send a global notification to everyone you can also do

GetNotificationSystem().CreateNotification( new StringLocaliser( "HELLO WORLD" ), new StringLocaliser( "Let's go to another quest !" ), EXPANSION_NOTIFICATION_ICON_ERROR, COLOR_EXPANSION_NOTIFICATION_ERROR, 5 );