# CFX::GET_TIMECYCLE_MODIFIER_INDEX_BY_NAME

- **Hash:** `0x5F4CD0E2`
- **Namespace:** CFX
- **Runtime name (Lua/JS):** `GetTimecycleModifierIndexByName`
- **Side:** client (Cfx runtime native)
- **Name status:** official
- **Documentation:** described with examples
- **URL:** https://natives.borderlinerp.com/natives/CFX/GET_TIMECYCLE_MODIFIER_INDEX_BY_NAME

## Signature

```c
int GET_TIMECYCLE_MODIFIER_INDEX_BY_NAME(char* modifierName);
```

## Parameters

- `modifierName` (`char*`) — The timecycle modifier name.

## Returns

`int` — The timecycle modifier index.

## Usage

### Lua

```lua
local retval = GetTimecycleModifierIndexByName(modifierName)

-- always available, by hash
local retval = Citizen.InvokeNative(0x5f4cd0e2, modifierName, Citizen.ResultAsInteger())
```

### JavaScript

```js
const retval = GetTimecycleModifierIndexByName(modifierName);

// by hash
const retval = Citizen.invokeNative('0x5f4cd0e2', modifierName, Citizen.returnResultAnyway(), Citizen.resultAsInteger());
```

### C#

```csharp
int retval = Function.Call<int>((Hash)0x5f4cd0e2, modifierName);
```

## Examples

*Source: Cfx.re native reference*

```lua
local modifierIndex = GetTimecycleModifierIndexByName("underwater")
local currentIndex = GetTimecycleModifierIndex()

if currentIndex ~= -1 and currentIndex == modifierIndex then
  print("we're actually using 'underwater' timecycle!")
end
```

*Sources: Cfx.re native reference.*