Bikers: Clubhouse 2 - Bob74/bob74_ipl GitHub Wiki

Getting the main object to interact with the interior:

BikerClubhouse2 = exports['bob74_ipl']:GetBikerClubhouse2Object()

Coordinates

This interior can be found at:

X	Y	Z
998.4809	-3164.711	-38.90733

Object structure

BikerClubhouse2
  +-- interiorId
  +-- Ipl
  |   +-- Interior
  |      +-- ipl
  |      +-- Load()
  |      +-- Remove()
  +-- Walls
  |   +-- brick
  |   +-- plain
  |   +-- Color
  |      +-- greenAndGray
  |      +-- multicolor
  |      +-- orangeAndGray
  |      +-- blue
  |      +-- lightBlueAndSable
  |      +-- greenAndRed
  |      +-- yellowAndGray
  |      +-- red
  |      +-- fuchsiaAndGray
  |   +-- Set(walls, color, refresh)
  |   +-- Clear(refresh)
  +-- LowerWalls
  |   +-- default
  |   +-- SetColor(color, refresh)
  +-- Furnitures
  |   +-- A
  |   +-- B
  |   +-- Color
  |      +-- turquoise
  |      +-- brown
  |      +-- brown2
  |      +-- darkBrown
  |      +-- red
  |      +-- red2
  |      +-- gray
  |      +-- darkGray
  |      +-- black
  |   +-- Set(furn, color, refresh)
  |   +-- Clear(refresh)
  +-- Decoration
  |   +-- A
  |   +-- B
  |   +-- Set(deco, color, refresh)
  |   +-- Clear(refresh)
  +-- Mural
  |   +-- none
  |   +-- death1
  |   +-- death2
  |   +-- death3
  |   +-- cityBlack
  |   +-- cityColor1
  |   +-- cityColor2
  |   +-- cityColor3
  |   +-- cityColor4
  |   +-- graffitis
  |   +-- Set(mural, refresh)
  |   +-- Clear(refresh)
  +-- GunLocker
  |   +-- on
  |   +-- off
  |   +-- Set(locker, refresh)
  |   +-- Clear(refresh)
  +-- ModBooth
  |   +-- none
  |   +-- on
  |   +-- off
  |   +-- Set(mod, refresh)
  |   +-- Clear(refresh)
  +-- Meth
  |   +-- none
  |   +-- stage1
  |   +-- stage2
  |   +-- stage3
  |   +-- Set(stage, refresh)
  |   +-- Clear(refresh)
  +-- Cash
  |   +-- none
  |   +-- stage1
  |   +-- stage2
  |   +-- stage3
  |   +-- Set(stage, refresh)
  |   +-- Clear(refresh)
  +-- Weed
  |   +-- none
  |   +-- stage1
  |   +-- stage2
  |   +-- stage3
  |   +-- Set(stage, refresh)
  |   +-- Clear(refresh)
  +-- Coke
  |   +-- none
  |   +-- stage1
  |   +-- stage2
  |   +-- stage3
  |   +-- Set(stage, refresh)
  |   +-- Clear(refresh)
  +-- Counterfeit
  |   +-- none
  |   +-- stage1
  |   +-- stage2
  |   +-- stage3
  |   +-- Set(stage, refresh)
  |   +-- Clear(refresh)
  +-- Documents
  |   +-- none
  |   +-- stage1
  |   +-- stage2
  |   +-- stage3
  |   +-- Set(stage, refresh)
  |   +-- Clear(refresh)
  +-- LoadDefault()

Walls

Setting the interior's style:

BikerClubhouse2.Walls.Set(walls, color, refresh)

Parameter	Description	Valid values
wall	Bricked wall	`BikerClubhouse2.Walls.brick`
	Plain wall	`BikerClubhouse2.Walls.plain`
color	Sable	`BikerClubhouse2.Walls.Color.sable`
	Yellow/Gray	`BikerClubhouse2.Walls.Color.yellowGray`
	Red	`BikerClubhouse2.Walls.Color.red`
	Brown	`BikerClubhouse2.Walls.Color.brown`
	Yellow	`BikerClubhouse2.Walls.Color.yellow`
	Light Yellow	`BikerClubhouse2.Walls.Color.lightYellow`
	Light Yellow/Gray	`BikerClubhouse2.Walls.Color.lightYellowGray`
	Light Gray	`BikerClubhouse2.Walls.Color.lightGray`
	Orange	`BikerClubhouse2.Walls.Color.orange`
	Gray	`BikerClubhouse2.Walls.Color.gray`
refresh	Refresh the whole interior	`true` or `false`

Furnitures

Setting the furniture's style (colors only works for the bar using BikerClubhouse2.Furnitures.B):

BikerClubhouse2.Furnitures.Set(furn, color, refresh)

Parameter	Description	Valid values
furn	Old couch	`BikerClubhouse2.Furnitures.A`
	Sofa	`BikerClubhouse2.Furnitures.B`
color	Turquoise	`BikerClubhouse2.Furnitures.Color.turquoise`
	Brown	`BikerClubhouse2.Furnitures.Color.brown`
	Brown 2	`BikerClubhouse2.Furnitures.Color.brown2`
	Dark Brown	`BikerClubhouse2.Furnitures.Color.darkBrown`
	Red	`BikerClubhouse2.Furnitures.Color.red`
	Red 2	`BikerClubhouse2.Furnitures.Color.red2`
	Gray	`BikerClubhouse2.Furnitures.Color.gray`
	Dark Gray	`BikerClubhouse2.Furnitures.Color.darkGray`
	Black	`BikerClubhouse2.Furnitures.Color.black`
refresh	Refresh the whole interior	`true` or `false`

Decoration

Setting the decoration's style:

BikerClubhouse2.Decoration.Set(deco, refresh)

Parameter	Description	Valid values
deco	Decoration style	`BikerClubhouse2.Decoration.A`
	Decoration style	`BikerClubhouse2.Decoration.B`
refresh	Refresh the whole interior	`true` or `false`

Mural

Setting the painting on the wall:

BikerClubhouse2.Mural.Set(mural, refresh)

Parameter	Description	Valid values
mural	No painting	`BikerClubhouse2.Mural.none`
	Death 1	`BikerClubhouse2.Mural.death1`
	Death 2	`BikerClubhouse2.Mural.death2`
	Death 3	`BikerClubhouse2.Mural.death3`
	City Black	`BikerClubhouse2.Mural.cityBlack`
	City Color 1	`BikerClubhouse2.Mural.cityColor1`
	City Color 2	`BikerClubhouse2.Mural.cityColor2`
	City Color 3	`BikerClubhouse2.Mural.cityColor3`
	City Color 4	`BikerClubhouse2.Mural.cityColor4`
	Graffitis	`BikerClubhouse2.Mural.graffitis`
refresh	Refresh the whole interior	`true` or `false`

GunLocker

Setting the gun locker state:

BikerClubhouse2.GunLocker.Set(locker, refresh)

Parameter	Description	Valid values
locker	Clutter	`BikerClubhouse2.GunLocker.off`
	Gun locker	`BikerClubhouse2.GunLocker.on`
refresh	Refresh the whole interior	`true` or `false`

ModBooth

Setting the mod booth state:

BikerClubhouse2.ModBooth.Set(mod, refresh)

Parameter	Description	Valid values
mod	No mod booth	`BikerClubhouse2.ModBooth.none`
	Clutter	`BikerClubhouse2.ModBooth.off`
	Mod booth	`BikerClubhouse2.ModBooth.on`
refresh	Refresh the whole interior	`true` or `false`

Meth

Adding meth to the interior:

BikerClubhouse2.Meth.Set(stage, refresh)

Parameter	Description	Valid values
stage	No meth	`BikerClubhouse2.Meth.none`
	Stage 1	`BikerClubhouse2.Meth.stage1`
	Stage 2	`BikerClubhouse2.Meth.stage2`
	Stage 3	`BikerClubhouse2.Meth.stage3`
refresh	Refresh the whole interior	`true` or `false`

Cash

Adding cash to the interior:

BikerClubhouse2.Cash.Set(stage, refresh)

Parameter	Description	Valid values
stage	No cash	`BikerClubhouse2.Cash.none`
	Stage 1	`BikerClubhouse2.Cash.stage1`
	Stage 2	`BikerClubhouse2.Cash.stage2`
	Stage 3	`BikerClubhouse2.Cash.stage3`
refresh	Refresh the whole interior	`true` or `false`

Weed

Adding weed to the interior:

BikerClubhouse2.Weed.Set(stage, refresh)

Parameter	Description	Valid values
stage	No weed	`BikerClubhouse2.Weed.none`
	Stage 1	`BikerClubhouse2.Weed.stage1`
	Stage 2	`BikerClubhouse2.Weed.stage2`
	Stage 3	`BikerClubhouse2.Weed.stage3`
refresh	Refresh the whole interior	`true` or `false`

Coke

Adding coke to the interior:

BikerClubhouse2.Coke.Set(stage, refresh)

Parameter	Description	Valid values
stage	No coke	`BikerClubhouse2.Coke.none`
	Stage 1	`BikerClubhouse2.Coke.stage1`
	Stage 2	`BikerClubhouse2.Coke.stage2`
	Stage 3	`BikerClubhouse2.Coke.stage3`
refresh	Refresh the whole interior	`true` or `false`

Counterfeit

Adding counterfeit cash to the interior:

BikerClubhouse2.Counterfeit.Set(stage, refresh)

Parameter	Description	Valid values
stage	No counterfeit cash	`BikerClubhouse2.Counterfeit.none`
	Stage 1	`BikerClubhouse2.Counterfeit.stage1`
	Stage 2	`BikerClubhouse2.Counterfeit.stage2`
	Stage 3	`BikerClubhouse2.Counterfeit.stage3`
refresh	Refresh the whole interior	`true` or `false`

Documents

Adding documents to the interior:

BikerClubhouse2.Documents.Set(stage, refresh)

Parameter	Description	Valid values
stage	No documents	`BikerClubhouse2.Documents.none`
	Stage 1	`BikerClubhouse2.Documents.stage1`
	Stage 2	`BikerClubhouse2.Documents.stage2`
	Stage 3	`BikerClubhouse2.Documents.stage3`
refresh	Refresh the whole interior	`true` or `false`

Default values set by `bob74_ipl`

LoadDefault = function()
    BikerClubhouse2.Ipl.Interior.Load()
    
    BikerClubhouse2.Walls.Set(BikerClubhouse2.Walls.brick, BikerClubhouse2.Walls.Color.red)
    BikerClubhouse2.LowerWalls.SetColor(BikerClubhouse2.Walls.Color.red)

    BikerClubhouse2.Furnitures.Set(BikerClubhouse2.Furnitures.B, BikerClubhouse2.Furnitures.Color.black)
    BikerClubhouse2.Decoration.Set(BikerClubhouse2.Decoration.B)
    BikerClubhouse2.Mural.Set(BikerClubhouse2.Mural.death3)

    BikerClubhouse2.ModBooth.Set(BikerClubhouse2.ModBooth.off)
    BikerClubhouse2.GunLocker.Set(BikerClubhouse2.GunLocker.off)

    BikerClubhouse2.Meth.Set(BikerClubhouse2.Meth.none)
    BikerClubhouse2.Cash.Set(BikerClubhouse2.Cash.none)
    BikerClubhouse2.Coke.Set(BikerClubhouse2.Coke.none)
    BikerClubhouse2.Weed.Set(BikerClubhouse2.Weed.none)
    BikerClubhouse2.Counterfeit.Set(BikerClubhouse2.Counterfeit.none)
    BikerClubhouse2.Documents.Set(BikerClubhouse2.Documents.none)

    RefreshInterior(BikerClubhouse2.interiorId)
end

Example: How to use in your own resources

You can handle and customize the interiors in your own resources using the exported functions:

Citizen.CreateThread(function()
    -- Getting the object to interact with
    BikerClubhouse2 = exports['bob74_ipl']:GetBikerClubhouse2Object()

    -- Setting red bricked walls
    BikerClubhouse2.Walls.Set(BikerClubhouse2.Walls.brick, BikerClubhouse2.Walls.Color.red)

    -- Setting furnitures A
    BikerClubhouse2.Furnitures.Set(BikerClubhouse2.Furnitures.A, 0)

    -- Setting the decoration
    BikerClubhouse2.Decoration.Set(BikerClubhouse2.Decoration.A)

    -- Setting the big painting on the wall
    BikerClubhouse2.Mural.Set(BikerClubhouse2.Mural.cityBlack)

    -- Enabling gun locker
    BikerClubhouse2.GunLocker.Set(BikerClubhouse2.GunLocker.on)

    -- Enabling mod booth
    BikerClubhouse2.ModBooth.Set(BikerClubhouse2.ModBooth.on)

    -- Let's go a bit crazy and enable all drugs and fake documents on stage 3! (wouuh)
    BikerClubhouse2.Meth.Set(BikerClubhouse2.Meth.stage3)
    BikerClubhouse2.Cash.Set(BikerClubhouse2.Cash.stage3)
    BikerClubhouse2.Coke.Set(BikerClubhouse2.Coke.stage3)
    BikerClubhouse2.Weed.Set(BikerClubhouse2.Weed.stage3)
    BikerClubhouse2.Counterfeit.Set(BikerClubhouse2.Counterfeit.stage3)
    BikerClubhouse2.Documents.Set(BikerClubhouse2.Documents.stage3)

    RefreshInterior(BikerClubhouse2.interiorId)
end)